Skip to content

The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:

Add jsdoc guidance to `typescript-write` (#84025)

Will Frye73fab9a4ef6
diff --git a/.claude/skills/typescript-write/SKILL.md b/.claude/skills/typescript-write/SKILL.md
index 0b71fb9c581..c4ad2663b0e 100644
--- a/.claude/skills/typescript-write/SKILL.md
+++ b/.claude/skills/typescript-write/SKILL.md
@@ -94,6 +94,7 @@ Before frontend edits, including test-only changes, read `frontend/CLAUDE.md`, `
- **No comments by default**. Well-named identifiers carry the `what`.
- **Comments should be concise**. Add a short, concise comment only when the `why` is non-obvious: a workaround, a hidden invariant, a subtle ordering constraint, a clever reduction. Never document the actual implementation, focus on the intent and the why.
+- **JSDoc describes the contract, not the implementation**. On exported functions, hooks and components, say what the caller gets: what it does, what it returns and what happens in edge cases (e.g. `undefined` while loading).
## Test authoring