Style Handbook

The house style our documentation and commit messages follow, one rule to a page. Each rule is stated below, so you can find the one you need without reading the rest.

Every rule

  1. Capitalization When to capitalize, and when to leave a word lowercase.
  2. Code in Text What to set in code font, and how to explain placeholders.
  3. Code Samples How to introduce and present a code sample.
  4. Colons A colon indicates that closely related information follows.
  5. Commit Messages How to describe a change in the message that accompanies it.
  6. Dashes Which dash to use, and how it differs from a colon.
  7. Documenting Command-Line Syntax Recommendations for documenting command-line tools.
  8. Lists How to introduce and punctuate lists.
  9. Prefer People/Person-First Language When Appropriate Follow the community's own preference between person-first and identity-first language.