Skip to content

Git Workflow

Mandatory standards

  • Use git for all source-controlled changes
  • Keep commits focused on a single logical change when practical
  • Write commit messages that describe the change rather than the implementation trivia
  • Never rewrite shared history without a team-approved reason
  • Never commit secrets or generated credentials

Commit conventions

A commit message should tell reviewers what changed and why.

Recommended form:

  • Short imperative subject line
  • Optional body for context, tradeoffs, or follow-up work

Pull or merge request standards

A reviewable change should:

  • Explain the purpose of the change
  • Link to the relevant task, issue, or decision when available
  • Highlight breaking changes and operational impact
  • Include validation evidence when the change affects behavior

Branching strategy

Branches should be short-lived and purpose-driven.

Recommended branch names describe the work, such as feature, fix, chore, or docs branches.

  • Rebase or merge only in ways that preserve team workflow expectations
  • Keep branches synchronized with the target branch often enough to avoid surprise conflicts
  • Use protected branches where the workflow requires it