Skip to content

Conventions

Branch Naming

  • feat/<description> — new feature
  • fix/<description> — bug fix
  • chore/<description> — maintenance
  • docs/<description> — documentation only
  • spike/<description> — exploratory work

Commit Messages

Follow Conventional Commits:

feat: add login screen
fix: correct padding on card component
docs: update setup instructions
chore: upgrade dependencies

MR Rules

  • No direct pushes to main
  • Pipeline must be green before merge
  • Architect + Maintainer review required (see CODEOWNERS)
  • Coverage must remain > 80%

Documentation Rules

  • Every feature MR must include a docs/ update
  • No docs = MR blocked
  • ADRs required for any significant architectural decision
  • Use MADR format for ADRs

Code Quality

  • Test coverage > 80% (enforced by CI)
  • No linting errors on merge
  • No commented-out code committed to main