use-a-coherent-style.md

order	15
edirect_from	criteria/style

Use a coherent style

Requirements

• Instructions for adding a CONTRIBUTING file on GitHub. GitHub links CONTRIBUTING in multiple places as part of a repo's community profile.

Use a coherent style

The codebase MUST use a coding or writing style guide, either the codebase community's own or an existing one referred to in the codebase.

Examples

• Basic guidelines: OpenZaak
• Guidelines of a very mature project: Git

Contributions SHOULD pass automated tests on style.

Resources

• List of linters by Hugo Martins.

The style guide SHOULD include expectations for inline comments and documentation for non-trivial sections.

Examples

Including expectations for understandable English in the style guide is OPTIONAL.

Examples