Skip to content

Latest commit

 

History

History
17 lines (9 loc) · 769 Bytes

document-conventions.md

File metadata and controls

17 lines (9 loc) · 769 Bytes

Document Conventions

This document makes use of specific terms as the foundation for the guidelines herein.

  • AVOID & PREFER, SHOULD & SHOULD NOT

    Unenforced guidelines that represent common practices for which there may be viable alternatives depending on the use-case.

  • CONSIDER

    Often associated with AVOID & PREFER guidelines, this lists considered alternatives to standard practices.

  • DO & DO NOT, MUST & MUST NOT

    Enforced rules that outlines a rule which must be followed. The exceptions to this rule should be rare and must be justified in documentation.

All rules and guidelines should contain reasons for the guidelines so they can be properly maintained and exceptions can be made, when appropriate.