docs: establish ADR framework with template and agent guidelines#1633
docs: establish ADR framework with template and agent guidelines#1633akurinnoy wants to merge 3 commits into
Conversation
Add README, template, and agent instructions for Architecture Decision Records. Update root AGENTS.md and .claude/CLAUDE.md so agents know when and how to create ADRs without needing to be in the adr/ directory. Assisted-by: Claude Code Signed-off-by: Oleksii Kurinnyi <okurynny@redhat.com> Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> Signed-off-by: Oleksii Kurinnyi <okurinny@redhat.com>
ADR documenting why the backup registry auth secret must not be owned by any workspace, including alternatives considered and trade-offs accepted. Assisted-by: Claude Code Signed-off-by: Oleksii Kurinnyi <okurynny@redhat.com> Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> Signed-off-by: Oleksii Kurinnyi <okurinny@redhat.com>
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: akurinnoy The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
|
Warning Rate limit exceeded
You’ve run out of usage credits. Purchase more in the billing tab. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 📝 WalkthroughWalkthroughThis PR establishes an Architecture Decision Records (ADRs) process for the project. It creates the ADR directory infrastructure with README, template, and agent maintenance guide; integrates ADR guidance into project documentation; and records the first ADR documenting backup registry auth secret lifecycle changes. ChangesADR Framework and First Decision
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Suggested labels
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
|
Hi! I'm che-ai-assistant — I help with your pull requests. Available commands:
|
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
AGENTS.md (1)
785-785:⚠️ Potential issue | 🟡 Minor | ⚡ Quick winUpdate stale "Last Updated" metadata.
AGENTS.mdwas modified in this PR, but Line 785 still says2025-12-24. Please bump it to the actual update date to keep document metadata trustworthy.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@AGENTS.md` at line 785, Update the stale "Last Updated" metadata by replacing the existing date string "2025-12-24" in the AGENTS.md header with the actual update date for this PR (use the current repo update date, e.g., "2026-05-15"), so the document's Last Updated field accurately reflects this modification.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Outside diff comments:
In `@AGENTS.md`:
- Line 785: Update the stale "Last Updated" metadata by replacing the existing
date string "2025-12-24" in the AGENTS.md header with the actual update date for
this PR (use the current repo update date, e.g., "2026-05-15"), so the
document's Last Updated field accurately reflects this modification.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: e50f32ea-19f8-40af-9518-5449c4282909
📒 Files selected for processing (6)
.claude/CLAUDE.mdAGENTS.mdadr/2026-05-11-backup-auth-secret-lifecycle.mdadr/AGENTS.mdadr/README.mdadr/TEMPLATE.md
Signed-off-by: Oleksii Kurinnyi <okurynny@redhat.com> Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> Signed-off-by: Oleksii Kurinnyi <okurinny@redhat.com>
What does this PR do?
Introduces Architecture Decision Records (ADRs) to the project: adds
adr/directory with a README, template, maintenance guide for AI agents, and the first ADR documenting the backup auth secret lifecycle decision. Updates rootAGENTS.mdand.claude/CLAUDE.mdwith criteria for when to create an ADR.What issues does this PR fix or reference?
Is it tested? How?
PR Checklist
/test v8-devworkspace-operator-e2e, v8-che-happy-pathto trigger)v8-devworkspace-operator-e2e: DevWorkspace e2e testv8-che-happy-path: Happy path for verification integration with CheSummary by CodeRabbit
Documentation
Bug Fixes