chore(docs): add JSDoc guardrail to CLAUDE.md always-on guardrails#3154
chore(docs): add JSDoc guardrail to CLAUDE.md always-on guardrails#3154PierreBrisorgueil merged 2 commits intomasterfrom
Conversation
|
Warning Rate limit exceeded
⌛ 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. 📒 Files selected for processing (2)
📝 WalkthroughWalkthroughAdded a new always-on guardrail to Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
Pull request overview
This PR adds the JSDoc header requirement to the Always-on guardrails section of CLAUDE.md, aligning it with the existing documentation in copilot-instructions.md and ERRORS.md. This ensures consistency across all AI instruction files in the repository.
Changes:
- Added JSDoc guardrail bullet point to CLAUDE.md's Always-on guardrails section
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #3154 +/- ##
=======================================
Coverage 89.85% 89.85%
=======================================
Files 52 52
Lines 1163 1163
Branches 233 233
=======================================
Hits 1045 1045
Misses 107 107
Partials 11 11 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
88fd47e to
5a5fbd1
Compare
Summary
Always-on guardrailssection ofCLAUDE.mdERRORS.mdCloses #3155
Why
The JSDoc requirement was already documented in
copilot-instructions.mdandERRORS.mdbut missing fromCLAUDE.md. The Vue stack has this guardrail in its CLAUDE.md — this aligns both stacks consistently.Scope
One line addition in
CLAUDE.md+ one line inERRORS.md— no functional impact.Validation
Guardrails