propagate-adr-with-traceability

How-to: Propagate ADR with Explicit Traceability

This guide explains how to run .github/prompts/propagate-adr.prompt.md so that every updated file references the ADR.

Steps

  1. Ensure your ADR status is Accepted and note its path, e.g., docs/adr/adr-0001-*.md.
  2. Run the Propagate ADR prompt and provide ${input:ADRPath}.
  3. Review the change plan and confirm.
  4. Verify changes:
    • Front matter contains adr_refs: ["ADR-NNNN"] when front matter exists
    • A Change History entry is appended with the date and ADR path
    • If no front matter, a top-of-file Markdown comment is added noting ADR-NNNN and path
    • Traceability tables include an ADR reference column/footnote if applicable

Notes

  • Changes are minimal-diff; unrelated reflows should be avoided.
  • Code is never modified by propagation; only docs/spec/plans are updated.