docs: add AI assistant contributor guidance for AMRIT hub repo#151
docs: add AI assistant contributor guidance for AMRIT hub repo#151theUtkarshRaj wants to merge 2 commits intoPSMRI:mainfrom
Conversation
|
Warning Rate limit exceeded
To continue reviewing without waiting, purchase usage credits 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. 📝 WalkthroughWalkthroughA new documentation file ChangesAMRIT Framework Documentation
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes 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)
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.
🧹 Nitpick comments (2)
CLAUDE.md (2)
1-1: 💤 Low valueConsider a more generic filename.
The filename
CLAUDE.mdis specific to one AI assistant (Anthropic's Claude), but the content is applicable to any AI coding assistant. Consider whether a more generic name likeAI_ASSISTANT_GUIDE.mdorAI_CODING_ASSISTANT.mdwould better reflect the universal applicability of the guidance, especially given issue#131's goal of "compatibility with ≥2 AI agents."🤖 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 `@CLAUDE.md` at line 1, The filename CLAUDE.md is too specific to one AI assistant; rename the file (e.g., AI_ASSISTANT_GUIDE.md or AI_CODING_ASSISTANT.md) and update any references to CLAUDE.md in docs, README, CONTRIBUTING, and CI/packaging configs so links and badges still work; ensure the file header and any internal references are made generic (replace occurrences of "Claude" with "AI assistant" or a neutral term) to align with issue `#131`'s goal of compatibility with multiple AI agents.
32-32: 💤 Low valueConsider adding a reference link for the all-contributors flow.
Line 32 mentions "the all-contributors flow" but doesn't explain what it is or link to documentation. Consider adding a reference to https://allcontributors.org/ or the bot documentation to help contributors understand this process.
📝 Suggested addition
-- For contributor table updates, use the all-contributors flow instead of manual edits. +- For contributor table updates, use the [all-contributors flow](https://allcontributors.org/docs/en/bot/usage) instead of manual edits.🤖 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 `@CLAUDE.md` at line 32, Update the sentence "For contributor table updates, use the all-contributors flow instead of manual edits." to include a reference link and brief guidance; add a parenthetical or inline link to https://allcontributors.org/ (or the project's all-contributors bot docs) so contributors can find the workflow and bot instructions easily, e.g., append "see https://allcontributors.org/ for details" or similar wording right after the sentence.
🤖 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.
Nitpick comments:
In `@CLAUDE.md`:
- Line 1: The filename CLAUDE.md is too specific to one AI assistant; rename the
file (e.g., AI_ASSISTANT_GUIDE.md or AI_CODING_ASSISTANT.md) and update any
references to CLAUDE.md in docs, README, CONTRIBUTING, and CI/packaging configs
so links and badges still work; ensure the file header and any internal
references are made generic (replace occurrences of "Claude" with "AI assistant"
or a neutral term) to align with issue `#131`'s goal of compatibility with
multiple AI agents.
- Line 32: Update the sentence "For contributor table updates, use the
all-contributors flow instead of manual edits." to include a reference link and
brief guidance; add a parenthetical or inline link to
https://allcontributors.org/ (or the project's all-contributors bot docs) so
contributors can find the workflow and bot instructions easily, e.g., append
"see https://allcontributors.org/ for details" or similar wording right after
the sentence.
1 participant
Summary
Adds a
CLAUDE.mdfile containing repository-specific guidance for contributors and AI coding assistants working with the AMRIT ecosystem.The document clarifies:
This contribution is intended as an initial step toward AI-agent compatible repository guidance referenced in issue #131.
Type of Change
Additional Information
This PR only adds contributor-facing documentation and does not modify application code or build configuration.
Closes #131
Summary by CodeRabbit