Document codebase maturity

Requirements

The codebase MUST be versioned.

Remember to document your versioning strategy to make it clear to other contributors.

Resources

• Semantic versioning, one common specification for versioning of software.

Examples

• OS2Forms tags (following semantic versioning)

The codebase MUST prominently document whether or not there are versions of the codebase that are ready to use.

Examples

Further reading

• Service Design and Delivery Process by the Australian Digital Transformation Agency, describes how to follow the service design and delivery process: what you need to do in Discovery, Alpha, Beta and Live stages.
• Service Manual on Agile Delivery by the UK Government Digital Service, among other things it describes the phases discovery, alpha, beta, live and retirement of an agile project.

Codebase versions that are ready to use MUST only depend on versions of other codebases that are also ready to use.

The codebase SHOULD contain a log of changes from version to version, for example in the CHANGELOG.

Examples

• OpenZaak CHANGELOG

The method for assigning version identifiers SHOULD be documented.

It is OPTIONAL to use semantic versioning.