Skip to content

Architectural Decision Records (ADRs)ยค

This project uses Compliance Trestle to generate and enforce the structure of ADRs. Read more about how trestle author is used to enforce template structure here

In order to generate a new ADR:

  1. cd {REPO_ROOT}/docs
  2. Use trestle author docs create-sample -tn ADR to generate a new ADR document.
  3. Write your ADR with the created documentation.
  4. Validate the ADR with trestle author docs validate -tn ADR -hv from {REPO_ROOT}/docs
  5. This is also completed as part of the test pipeline
  6. Commit and run through the standard PR review process.