Skip to content

Add ADR maintenance instructions to agent-ready CLAUDE.md template#29

Merged
dgalarza merged 2 commits intomainfrom
claude/add-instructions-to-claude-md
Mar 17, 2026
Merged

Add ADR maintenance instructions to agent-ready CLAUDE.md template#29
dgalarza merged 2 commits intomainfrom
claude/add-instructions-to-claude-md

Conversation

@Claude
Copy link
Copy Markdown
Contributor

@Claude Claude AI commented Mar 17, 2026

The agent-ready skill bootstraps an ADR system in docs/decisions/ but doesn't include instructions in the generated CLAUDE.md on how to maintain it.

Changes

  • claude-md-template.md: Added "Architecture Decision Records" section with clear guidance on when to write ADRs (architectural choices, technology adoption, cross-cutting patterns, design trade-offs) and links to the ADR directory

  • SKILL.md:

    • Added ADR detection in Step 3 to check for existing decision records
    • Updated Step 4 to explicitly include ADR section when ADRs are detected or when bootstrapping new documentation

Now when generating CLAUDE.md, the skill will include:

## Architecture Decision Records
When making significant architectural decisions, create an ADR in [docs/decisions/](docs/decisions/).

Write an ADR when:
- Choosing between competing architectural approaches
- Adopting or rejecting a major technology or framework
- Establishing cross-cutting patterns (auth, logging, error handling)
- Making trade-offs that affect system design

Use the [ADR template](docs/decisions/) to document context, the decision, consequences, and alternatives considered.
Original prompt

This section details on the original issue you should resolve

<issue_title>agent-ready ADR instructions</issue_title>
<issue_description>As part of the agent-ready skill we bootstrap an ADR system in docs. However we don't include instructions in the CLAUDE.md to maintain it.</issue_description>

Comments on the Issue (you are @claude[agent] in this section)

Co-authored-by: dgalarza <105694+dgalarza@users.noreply.github.com>
@Claude Claude AI changed the title [WIP] Add instructions for maintaining agent-ready ADR system Add ADR maintenance instructions to agent-ready CLAUDE.md template Mar 17, 2026
@Claude Claude AI requested a review from dgalarza March 17, 2026 14:20
@dgalarza dgalarza marked this pull request as ready for review March 17, 2026 14:22
@dgalarza dgalarza merged commit d969e35 into main Mar 17, 2026
2 checks passed
@dgalarza dgalarza deleted the claude/add-instructions-to-claude-md branch March 17, 2026 14:25
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.

agent-ready ADR instructions

2 participants