Skip to content

Commit 80138fd

Browse files
docs(guardrails): enforce JSDoc on every new or modified function
1 parent ecce8ee commit 80138fd

2 files changed

Lines changed: 2 additions & 0 deletions

File tree

.github/copilot-instructions.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@ Use `.github/prompts/*.prompt.md` for guided workflows:
3737
- Avoid risky renames or moves of core stack paths used by downstream merges
3838
- Keep changes minimal and merge-friendly for downstream projects
3939
- Flag security or mergeability risks explicitly in reviews
40+
- Every new or modified function must have a JSDoc header: one-line description, `@param` for each argument, `@returns` if the function returns a value
4041

4142
## Architecture and modularity
4243

ERRORS.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,3 +11,4 @@ Use this file as a compact memory of recurring AI mistakes.
1111

1212
## Entries
1313

14+
- [2026-02-22] functions: added functions without JSDoc header -> always add JSDoc (description + @param + @returns)

0 commit comments

Comments
 (0)