Skip to content

Preggy-Health/styleguide

Repository files navigation

Preggy Health Style Guides

Every major project has its own style guide: a set of conventions (sometimes arbitrary) about how to write code for that project. It is much easier to understand a large codebase when all the code in it is in a consistent style.

“Style” covers a lot of ground, from “use camelCase for variable names” to “never use global variables” to “never use exceptions.” This project (Preggy-Health/styleguide) links to the style guidelines we use for Preggy Health code. If you are modifying a project that originated at Preggy Health, you may be pointed to this page to see the style guides that apply to that project.

If your project requires that you create a new XML document format, the XML Document Format Style Guide may be helpful. In addition to actual style rules, it also contains advice on designing your own vs. adapting an existing format, on XML instance document formatting, and on elements vs. attributes.

The style guides in this project are licensed under the CC-By 3.0 License, which encourages you to share these documents. See https://creativecommons.org/licenses/by/3.0/ for more details.

The following Dart style guide lives outside of this project: Effective Dart.

Creative Commons License