chore: add AGENTS.md/CLAUDE.md and tune CodeRabbit review config#2065
Conversation
Adi-204
requested review from
Florence-Njeri,
asyncapi-bot-eve,
derberg,
jonaslagoni and
magicmatatjahu
as code owners
|
What reviewer looks at during PR reviewThe following are ideal points maintainers look for during review. Reviewing these points yourself beforehand can help streamline the review process and reduce time to merge.
|
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
📝 WalkthroughWalkthroughAdds repository-wide Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes 🚥 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)
Tip 💬 Introducing Slack Agent: The best way for teams to turn conversations into code.Slack Agent is built on CodeRabbit's deep understanding of your code, so your team can collaborate across the entire SDLC without losing context.
Built for teams:
One agent for your entire SDLC. Right inside Slack. 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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@AGENT.md`:
- Around line 13-24: Update the fenced code blocks in AGENT.md that show the
directory trees so they include a language identifier (e.g., change ``` to
```text); specifically modify the block containing the "apps/ ... packages/ ..."
tree and the block containing the "<client>/ ... template/ components/ test/
..." tree (also apply same change to the other instance around the "<client>/"
example mentioned in lines 180-189) so both opening fences read ```text to
satisfy markdownlint MD040.
- Around line 92-97: The taxonomy text uses "client" but the repo convention and
existing dirs use "clients"; update the sentence and the type set so they match
the established naming (e.g., change "type ∈ {client, sdk, docs, scripts}" to
"type ∈ {clients, sdk, docs, scripts}" or otherwise consistently refer to
"packages/templates/clients/..."), and update the explanatory bullets
(references to `client` and "client template") to the plural `clients` (or
choose the singular and rename directories across the repo with an accompanying
issue/discussion), ensuring consistency for the Template-type taxonomy block and
any mentions of `packages/templates/<type>/...`.
In `@packages/templates/clients/websocket/test/README.md`:
- Line 138: Replace the shell-specific example "TEST_CLIENT=python jest" with a
cross-platform instruction: either reference the npm script "npm run
test:python" (ensure package.json contains a "test:python" script that sets
TEST_CLIENT and runs jest) or recommend using cross-env (e.g., a "test:python"
script that uses cross-env to set TEST_CLIENT before invoking jest) so Windows
users can run the same command; update the README.md line to show the
cross-platform approach and mention adding "-u" for updating snapshots.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: ffcecab0-5e30-4c79-91d0-b2dbc870968e
📒 Files selected for processing (3)
.coderabbit.yamlAGENT.mdpackages/templates/clients/websocket/test/README.md
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@AGENT.md`:
- Around line 53-55: Update the release-prefix guidance in AGENT.md so it
matches section 2.5: replace the current sentence that limits triggers to only
`feat:`/`fix:` with the full, unified set of release-triggering prefixes
(`feat:`, `feat!:`, `fix:`, `fix!:`, and `chore(release):`), and ensure the note
about requiring a `.changeset/*.md` for `feat:`/`fix:` diffs in publishable
packages remains intact; update any example or wording that conflicts (search
for the current line mentioning `feat:` / `fix:` and the later mention of
`feat!:/fix!:/chore(release):`) so both sections use identical wording.
🪄 Autofix (Beta)
❌ Autofix failed (check again to retry)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@AGENT.md`:
- Line 54: Update the rule sentence that currently reads "Any `feat:` or `fix:`
in the diff of a publishable package..." to also require the breaking-change
variants by including backtick-marked tokens `feat!:`, `fix!:` (i.e., change the
phrase to "Any `feat:`, `fix:`, `feat!:`, or `fix!:` in the diff of a
publishable package ... must be accompanied by a `.changeset/*.md` file");
ensure the wording clearly ties `!`-marked commits to major-bump changesets so
it matches the release/major-bump rules elsewhere in the document.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@AGENT.md`:
- Line 79: Update the sentence on Line 79 of AGENT.md to explicitly list all
five patterns the release workflow checks (startsWith(..., 'feat:'),
startsWith(..., 'feat!:'), startsWith(..., 'fix:'), startsWith(..., 'fix!:'),
and startsWith(..., 'chore(release):')) and note that the workflow uses separate
startsWith() calls for each, so scoped prefixes like 'feat(generator):' will not
trigger a release; keep the rest of the paragraph unchanged.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
with referenced docs and cross-cutting section
Adi-204
force-pushed
the
feat/introduce-code-guidelines
branch
from
0ac124c to
e310bcf
Compare
derberg
left a comment
derberg
left a comment
There was a problem hiding this comment.
one last thing, also please add CLAUDE.md file (we both use Claude) that references the AGENT.md file
|
claude.md could be a symlink like others do: https://github.com/apache/airflow/blob/main/CLAUDE.md |
|
looks like better is to add |
|
@derberg putting |
Adi-204
changed the title
| **`CLAUDE.md` vs `AGENTS.md`:** The repo may ship `CLAUDE.md` as a symlink to `AGENTS.md` (one canonical guidelines file). After a clone, Linux and macOS usually need no extra step. On **Windows**, turn on **Developer Mode** (or equivalent symlink permission), run `git config core.symlinks true`, then `git checkout -- CLAUDE.md` so Git creates a real link—not a one-line text stub. Edit **`AGENTS.md`** only for content; the symlink follows automatically. | ||
|
|
There was a problem hiding this comment.
@derberg I'm currently on windows can you test for macOS according to web you should not require any additional git setup. So maybe we can merge this and if any problem occur we will update the guide for macOS. wdyt 🤔 ? or should I remove it?
There was a problem hiding this comment.
hey @Adi-204 , if u need any help in testing on macOS would love to help you out.
There was a problem hiding this comment.
Hey @Varadraj75 thanks for the help sure you can checkout in this branch locally and let me know.
derberg
left a comment
derberg
left a comment
There was a problem hiding this comment.
Merge when you want, all good from my side
once merged, I will give it a try
|
|
/rtm |
4 participants
Description
Introduces AGENT.md as the source of truth for code review standards across the asyncapi/generator monorepo, consumed by both human reviewers and AI agents (CodeRabbit). Also tightens CodeRabbit review configuration and refreshes the WebSocket integration-test README to reflect the per-client isolation model landed in #2042.
Related issue(s)
Fixes #2064
Summary by CodeRabbit
Documentation
Chores