docs: add AGENTS.md, fix v0.1 language matrix, clarify versioning#41
Conversation
Python and Go structural support landed in v0.1.5 via plain `feat:` PRs, but README and CLAUDE.md still listed Go as planned for v0.2 and Python's status was inconsistent. Make AGENTS.md the canonical agent-instructions file (so non-Claude agents pick it up) and point CLAUDE.md at it via symlink. Also document the Cargo 0.x SemVer carve-out: while < 1.0.0, plain `feat:` is a patch bump; `feat!:` is required to cut 0.2.0. The next language batch (C#, Kotlin, Ruby, PHP) is shifted to v0.2 and will land with `feat!:` so release-plz actually bumps the minor.
The previous wording told users to "wait for AQ's review" if none was present, but AQ doesn't auto-trigger on push (or at all, absent the org integration on initial open). Waiting alone never produces a review. Spell out the actual lever: post `/q review` as a PR comment. Apply the same clarification to the commit-lag section — if a user wants AQ to re-review the latest commit, they have to ask explicitly; AQ will not catch up on its own.
Pre-1.0 and post-1.0 columns now use distinct placeholders (`0.M.p` vs `m.n.p`) so the same letter never refers to two different version positions. Also add a "see bump table" pointer to the trigger-prefix bullet list, since on Cargo 0.x `fix:` and `feat:` both land as patch bumps and the bullet list alone is misleading.
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (5)
📝 WalkthroughWalkthroughThis PR updates project documentation and bot guidance: it introduces a new ChangesDocumentation and Agent Guidance Updates
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Review rate limit: 4/5 reviews remaining, refill in 12 minutes. Comment |
![amazon-q-developer[bot]](https://avatars.githubusercontent.com/in/1220912?s=60&v=4){kind=small}
There was a problem hiding this comment.
Documentation updates look good. The changes correctly reflect v0.1 Go support, clarify Amazon Q's manual trigger requirement, and establish AGENTS.md as the canonical agent instructions file with CLAUDE.md as a symlink. No defects found that block merge.
You can now have the agent implement changes and create commits directly on your pull request's source branch. Simply comment with /q followed by your request in natural language to ask the agent to make changes.
There was a problem hiding this comment.
Documentation updates look good. The changes correctly reflect v0.1 Go support, clarify Amazon Q's manual trigger requirement, and establish AGENTS.md as the canonical agent instructions file with CLAUDE.md as a symlink. No defects found that block merge.
You can now have the agent implement changes and create commits directly on your pull request's source branch. Simply comment with /q followed by your request in natural language to ask the agent to make changes.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
1 participant
Summary
Three docs fixes bundled into a single branch:
AGENTS.mdas canonical agent doc — addsAGENTS.md(the convention used by Codex/Aider/Cursor) and convertsCLAUDE.mdto a relative symlink so Claude Code keeps working without duplicating content.README.md(and the newAGENTS.md) now reflect that Python and Go structural support shipped in v0.1.5; planned languages (C#, Kotlin, Ruby, PHP) move from v0.3 → v0.2.feat:/feat!:/fix:to actual bumps both pre- and post-1.0. Placeholders use0.M.p(pre-1.0) andm.n.p(post-1.0) so the same letter never means two different positions. Calls out that a plainfeat:on0.1.xwill not produce0.2.0—feat!:or aBREAKING CHANGE:footer is required./address-pr-feedbackclarification — Amazon Q does not auto-trigger on push; users must post/q reviewas a PR comment to request a (re-)review.Changes
AGENTS.md— new, canonical agent instructionsCLAUDE.md— symlink →AGENTS.mdREADME.md— language matrix corrected, status callout updated.claude/commands/address-pr-feedback.md— explicit/q reviewtrigger guidanceTest plan
cat CLAUDE.mdresolves toAGENTS.mdcontents (symlink works locally)AGENTS.mdon GitHub — bump table renders cleanly with the new placeholdersREADME.mdon GitHub — supported-languages table shows Go asyes (v0.1)feat:/feat!:correctly on its next run (no config changes here, but the doc claims should hold)Summary by CodeRabbit
/q reviewcommand to initiate reviews.