Repository navigation
docs(agents): an ADR request in an issue or plan is still held to the bar - #122
Conversation
… bar Issues written before the ADR cleanup ask for "an ADR under dev-docs/adr" in their acceptance lists, and an agent following them wrote two records (bomly-cli ADR-0050 and ADR-0051) that failed the bar and were folded back into ADR-0020 and ARCHITECTURE.md in bomly-cli#531. The rule now says such a request asks for the decision to be recorded, not for a new file: the bar still decides, and a passing decision revises the live record that owns the topic first. The same section appears in both repositories and changes in both. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
|
No actionable comments were generated in the recent review.
|
| Layer / File(s) | Summary |
|---|---|
Documenting ADR decisions AGENTS.md |
The guidance says an ADR request alone does not require a new file. It directs contributors to document reasoning in a doc comment or AGENTS.md when the criteria are not met, and to state this in the pull request. When the criteria are met, it directs maintainers to revise the existing ADR or create one if none exists. |
Priority:
Estimated code review effort: 1 (Trivial) | ~3 minutes
Change: Other
Possibly related issues
- Resolve tag- and branch-pinned GitHub Actions references to commits under --enrich bomly-cli#525: The issue requires ADR-related documentation, which this guidance describes.
- model: DetectedOrigins unions in arrival order, so registry bytes depend on merge order #119: The issue raises whether origin ordering needs an ADR; this PR clarifies how to record that decision but does not change origin ordering.
Possibly related PRs
- bomly-dev/bomly-sdk#121: Its stated ADR handling is directly covered by the updated guidance.
Merge Risk: 
Minimal · up to 9f1a2
-
No merge-blocking issues were identified in the updated ADR guidance.
Pre-merge checks: 
5
-
Full details: Title check
-
Explanation
The title names the main change: an ADR request raised in an issue or plan is still held to the existing three-part ADR bar. The AGENTS.md summary and PR objectives confirm that the change clarifies this point and does not create a new file by default. The title uses the conventional docs(scope) prefix and is specific enough for a teammate scanning history to understand the change.
Full details: Docstring Coverage
-
Explanation
No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)
-
Finishing Touches
-
🧪 Generate unit tests (beta)
-
- Commit to this branch
- Create a new PR
-
- Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.
A rabbit reads the ADR guide,
No new file just for the ask.
If criteria fit, revise or add;
If not, record the reasoning.
Then hop along, with notes in hand.
Comment @coderabbitai help to get the list of available commands.
Bomly Diff SummaryCompared Overview
Dependency Changes✅ No dependency changes. Vulnerabilities✅ No vulnerability changes. License Changes✅ No license changes. Project Posture✅ No project posture changes ( Policy Findings✅ No policy differences were identified. |
Adds one rule to the shared ADR section of
AGENTS.md: an issue, plan or acceptance checklist that asks for an ADR is asking for the decision to be recorded, not for a new file. The three-part bar still decides.Why: the issues for planning#51 were written before the ADR cleanup and asked for ADRs in their acceptance lists. Following them produced bomly-cli ADR-0050 and ADR-0051, which failed the bar and were folded back into ADR-0020 and
dev-docs/ARCHITECTURE.mdin bomly-dev/bomly-cli#531.The section appears in both repositories and changes in both together: companion PR bomly-dev/bomly-cli#534.
🤖 Generated with Claude Code
Summary by CodeRabbit