Skip to content

chore(docs): add JSDoc guardrail to CLAUDE.md always-on guardrails#3154

Merged
PierreBrisorgueil merged 2 commits intomasterfrom
chore/add-jsdoc-guardrail
Feb 23, 2026
Merged

chore(docs): add JSDoc guardrail to CLAUDE.md always-on guardrails#3154
PierreBrisorgueil merged 2 commits intomasterfrom
chore/add-jsdoc-guardrail

Conversation

@PierreBrisorgueil
Copy link
Contributor

@PierreBrisorgueil PierreBrisorgueil commented Feb 23, 2026

Summary

  • Add JSDoc header requirement to the Always-on guardrails section of CLAUDE.md
  • Add pr skill monitor loop entry to ERRORS.md

Closes #3155

Why

The JSDoc requirement was already documented in copilot-instructions.md and ERRORS.md but missing from CLAUDE.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 in ERRORS.md — no functional impact.

Validation

  • No functional change
  • Aligned with Vue stack CLAUDE.md and Node copilot-instructions.md

Guardrails

  • No secrets or credentials
  • No cross-module coupling
  • Merge-friendly for downstream projects

@PierreBrisorgueil PierreBrisorgueil added the Chore release label Feb 23, 2026
@PierreBrisorgueil PierreBrisorgueil self-assigned this Feb 23, 2026
@PierreBrisorgueil PierreBrisorgueil marked this pull request as ready for review February 23, 2026 07:14
Copilot AI review requested due to automatic review settings February 23, 2026 07:14
@coderabbitai
Copy link

coderabbitai bot commented Feb 23, 2026

Warning

Rate limit exceeded

@PierreBrisorgueil has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 1 minutes and 48 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

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.

📥 Commits

Reviewing files that changed from the base of the PR and between 88fd47e and 5a5fbd1.

📒 Files selected for processing (2)
  • CLAUDE.md
  • ERRORS.md
📝 Walkthrough

Walkthrough

Added a new always-on guardrail to CLAUDE.md requiring JSDoc headers (one-line description, @param for each argument, and @returns for non-void/async functions) and updated ERRORS.md changelog entries (added 2026-02-23 entry; one-line no-op adjustment for 2026-02-22).

Changes

Cohort / File(s) Summary
Guardrails doc
CLAUDE.md
New requirement: every new or modified function must include a JSDoc header with a one-line description, @param for each argument, and @returns for non-void/async functions.
Change log
ERRORS.md
Updated changelog: removed/re-added a 2026-02-22 line (no-op) and added a 2026-02-23 entry describing an updated PR skill workflow to remain in the monitor loop after gh pr ready. No functional code changes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

Poem

🐇 I hopped through lines both old and new,
A tiny note for functions, neat and true.
Describe, list params, and returns in sight—
My JSDoc carrots shine so bright! ✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and specifically describes the main change: adding a JSDoc guardrail requirement to CLAUDE.md's always-on guardrails section.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Description check ✅ Passed The pull request description covers all key required sections: Summary (what changed and why), Scope (module impact and risk level), and Guardrails checks (no secrets, no risky changes, merge-friendly). The description is well-structured, provides clear rationale for the changes, and references the related issue.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch chore/add-jsdoc-guardrail

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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
Copy link

codecov bot commented Feb 23, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 89.85%. Comparing base (f97b05e) to head (5a5fbd1).
⚠️ Report is 1 commits behind head on master.

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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@PierreBrisorgueil PierreBrisorgueil force-pushed the chore/add-jsdoc-guardrail branch from 88fd47e to 5a5fbd1 Compare February 23, 2026 07:57
Copilot AI review requested due to automatic review settings February 23, 2026 07:57
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 1 out of 2 changed files in this pull request and generated no new comments.

@PierreBrisorgueil PierreBrisorgueil merged commit 3dc239b into master Feb 23, 2026
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Chore release

Projects

None yet

Development

Successfully merging this pull request may close these issues.

chore(docs): add JSDoc guardrail to CLAUDE.md always-on guardrails

2 participants