Repository navigation
chore: enforce architecture decision records #287
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
bd33c2e
chore: enforce architecture decision records
christian-byrne f900fed
docs: clarify portable ADR governance
christian-byrne c13877b
fix: validate ADR links and statuses
christian-byrne 77b8347
Merge remote-tracking branch 'origin/main' into chore/adr-governance
christian-byrne 4285219
docs(adr): incorporate governance review feedback
christian-byrne 04b9c48
fix(adr): close validator metadata and link gaps
christian-byrne File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| # ADR compliance | ||
|
|
||
| Treat accepted records in `docs/adr/` as architectural constraints until a | ||
| replacement record has itself been accepted. A proposed replacement does not | ||
| lift the existing constraint. Treat proposed records as review guidance. Read the decision and consequences for | ||
| every record relevant to the changed surface, and report only contradictions | ||
| introduced by the diff. Cite the full semantic identifier in every finding. | ||
|
|
||
| An architecture change needs an ADR when it establishes a durable boundary, | ||
| changes an invariant, chooses among viable system designs, or creates a | ||
| compatibility or migration policy. Implementation detail, transient test | ||
| evidence, and routine maintenance do not need ADRs. A deliberate deviation from | ||
| the package invariants still belongs in `docs/decisions/EXCEPTIONS.md`. | ||
|
|
||
| The template sections are recommendations. Do not report a finding solely | ||
| because an ADR omits or renames Context, Decision, Alternatives considered, | ||
| What we reject, Consequences, or Revisit triggers. Review whether the record | ||
| preserves enough rationale and impact to be useful for its specific decision, | ||
| including typed relations, testable proof, standing rejections, known limits, | ||
| and measurable revisit conditions when relevant. | ||
|
|
||
| <!-- coderabbit-instructions: {src/**,docs/adr/**} --> | ||
| ```text | ||
| Treat accepted ADRs in docs/adr/ as constraints until a replacement is itself Accepted; a Proposed replacement does not lift the existing constraint. Treat proposed ADRs as directional guidance. For source changes, read the decisions relevant to the affected op, state, replication, API, ordering, validation, or distribution surface. Flag only contradictions introduced by this diff, cite the full ADR identifier, and distinguish a conflict with an accepted record from disagreement with a proposal. If the diff establishes a durable architecture boundary, changes an invariant, chooses among viable system designs, or creates compatibility or migration policy without recording the tradeoff in docs/adr/, ask for an ADR. Do not demand an ADR for implementation detail, transient evidence, tests, or routine maintenance. Context, Decision, Alternatives considered, What we reject, Consequences, and Revisit triggers are recommended prompts, not required headings; do not fail an ADR solely because one is omitted or renamed. Review whether typed relations, testable proof, standing rejections, known limits, measurable revisit conditions, compatibility, and supersession are concrete and mutually consistent for the decision at hand. | ||
| ``` | ||
| <!-- /coderabbit-instructions --> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| name: ADR link validation | ||
|
|
||
| on: | ||
| push: | ||
| branches: [main] | ||
| pull_request: | ||
|
|
||
| permissions: | ||
| contents: read | ||
|
|
||
| jobs: | ||
| adr-links: | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1 | ||
| with: | ||
| persist-credentials: false | ||
| - uses: actions/setup-node@820762786026740c76f36085b0efc47a31fe5020 # v7.0.0 | ||
| with: | ||
| node-version: 22 | ||
| - name: Check ADR references resolve | ||
| run: node scripts/check-adr-links.mjs |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.