Skip to content

Commit 3dc239b

Browse files
chore(docs): add JSDoc guardrail to CLAUDE.md always-on guardrails (#3154)
* chore(docs): add JSDoc guardrail to always-on guardrails in CLAUDE.md * chore(docs): add pr skill monitor loop entry to ERRORS.md
1 parent f97b05e commit 3dc239b

2 files changed

Lines changed: 2 additions & 1 deletion

File tree

CLAUDE.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,7 @@ The `.claude/` folder contains embedded settings, skills, and agents that are av
5353
- Avoid risky renames or moves of core stack paths used by downstream merges
5454
- Keep changes minimal and merge-friendly for downstream projects
5555
- Flag security or mergeability risks explicitly in reviews
56+
- Every new or modified function must have a JSDoc header: one-line description, `@param` for each argument, `@returns` for any non-void return value (always include `@returns` for async functions to document the resolved value)
5657

5758
## Available embedded skills
5859

ERRORS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,4 +14,4 @@ Use this file as a compact memory of recurring AI mistakes.
1414
- [2026-02-22] functions: new or modified functions without JSDoc header -> always add JSDoc (description + `@param` for each arg + `@returns` for non-void return values and all async functions)
1515
- [2026-02-22] tests: never patch code to pass a test -> if a test is wrong, fix the test; if logic needs refactoring, refactor it
1616
- [2026-02-23] pr skill: stopping after `gh pr ready` -> always enter the monitor loop (wait CI → 3min grace → read feedback → iterate) until stop condition is met
17-
- [2026-02-23] pr skill: skipping issue creation when none found -> always create a GitHub issue before opening a PR (`gh issue create --web` or via CLI)
17+
- [2026-02-23] pr skill: skipping issue creation when none found -> always create a GitHub issue before opening a PR (`gh issue create --web` or via CLI)

0 commit comments

Comments
 (0)