Implementation guide for the Standard for Public Code

Document codebase objectives This criterion in the Standard for Public Code

Be on the lookout for people, organizations and initiatives with similar objectives to see if you can collaborate rather than compete.

Requirements

The codebase MUST contain documentation of its objectives, like a mission and goal statement, that is understandable by developers and designers so that they can use or contribute to the codebase.

Examples

Tools

Codebase documentation SHOULD clearly describe the connections between policy objectives and codebase objectives.

Examples

Documenting the objectives of the codebase for the general public is OPTIONAL.

Examples