Repository and Version Control Standards

Purpose

Repository standards ensure that code, configuration, documentation, and evidence are controlled.

Repository Requirements

Repositories should include:

• README

• contribution guidance

• branching strategy

• code owners where appropriate

• licence or IP notice

• setup instructions

• test instructions

• deployment instructions

• security notes

• changelog

Branching

Branching strategy must be defined for the project.

Typical branches include:

• main

• develop

• feature branches

• release branches

• hotfix branches

Commit Standards

Commits should be:

• clear

• traceable

• linked to work items where possible

• focused on a single logical change

Release Tags

Releases should be tagged and documented.