Skip to content

feat(dev): adr-lint checks the engine index and mentions of missing ADRs - #112

Merged
kcramakrishna merged 1 commit into
devfrom
fix/adr-lint-coverage
Nov 10, 2026
Merged

kcramakrishna merged 1 commit into
devfrom
fix/adr-lint-coverage

Conversation

@kcramakrishna

Copy link
Copy Markdown
Contributor

Summary

Closes two gaps in make adr-lint (from #111):

  • Engine index. audit/engine/docs/architecture/README.md indexes the engine ADRs. An engine ADR with no row
    there fails, and so does a row that links an ADR that does not exist. An index is required only when its folders
    hold an ADR.
  • Mentions of missing ADRs. Every Markdown page is read, except CHANGELOG.md, scratch, fixtures, build output
    and the greenfield templates. A page that names an ADR path (adrs/0004-slug.md, decisions/...) or an
    "ADR NNNN" number that no ADR folder holds fails, so a deleted ADR cannot stay referenced in prose. Limit: the
    number check cannot tell folders apart, so "ADR 0001" passes while any folder has a 0001.

Nothing in the repository is flagged today. The policy page, the style guide and the dev-tooling reference say what
the lint now checks.

Checks

  • make check, make security, make docs-lint (baseline 647), make commit-lint RANGE=origin/dev..HEAD: pass.
  • 22 tests in dev/tests/test_adr_lint.py.

🤖 Generated with Claude Code

The engine's architecture page indexes the engine ADRs. adr-lint now
fails when an engine ADR has no row there, or when the page links an ADR
that does not exist. An index is required only when its folders hold an
ADR.

adr-lint also reads every Markdown page, except CHANGELOG.md, scratch,
fixtures, build output and the greenfield templates. A page that names
an ADR path or an "ADR NNNN" number no folder holds fails, so a deleted
ADR cannot stay referenced in prose. The number check cannot tell
folders apart; the module docstring says so.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@kcramakrishna
kcramakrishna added this pull request to the merge queue Nov 10, 2026
Merged via the queue into dev with commit 2a492e5 Nov 10, 2026
18 checks passed
@kcramakrishna
kcramakrishna deleted the fix/adr-lint-coverage branch November 10, 2026 06:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant