Implementation guide for the Standard for Public Code

Contribute on GitHub

Use a coherent style This criterion in the Standard for Public Code

Requirements

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

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