Add comment-rules skill for TypeScript authoring

[jasonleenaylor]

Guides doc/inline comments toward why-focused brevity; tracks .claude/skills/ so repo skills are versioned.

---

This change is 

Summary by CodeRabbit

• Documentation

  • Added centralized TypeScript comment/JSDoc-writing guidelines, including rules for documenting exports vs internal symbols, when to use @param, @returns, and @throws, and permitted reference formatting.
  • Updated agents documentation to point to the centralized comment policy.

• Chores

  • Updated repository ignore rules to exclude all .claude/ content while ensuring the tracked skill documentation remains included.

[coderabbitai]

Warning

Review limit reached

@jasonleenaylor, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 46 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: d971c85f-9fa6-45dd-a957-6abf51d1929b

📥 Commits

Reviewing files that changed from the base of the PR and between 834fb72 and 542985b.

📒 Files selected for processing (2)

• .claude/skills/comment-rules/SKILL.md
• AGENTS.md

📝 Walkthrough

Walkthrough

Adds centralized TypeScript comment-writing guidelines, updates AGENTS.md to reference them, and adjusts .gitignore so .claude/skills/ remains tracked.

Changes

Comment Rules

Layer / File(s)	Summary
Comment guidance and repository wiring .claude/skills/comment-rules/SKILL.md, AGENTS.md, .gitignore	Defines TypeScript documentation and inline comment rules, centralizes the repository directive, and updates ignore patterns to track the skills directory.

Estimated code review effort: 1 (Trivial) | ~5 minutes

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly matches the main change: adding a TypeScript comment-rules skill.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch chore/comment-rules-skill

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}

[alex-rawlings-yyc]

This all looks good to me. I will defer to @imnasnainaec to approve so he can give his two cents before this is merged. Though now that I've written this out, I realize that it may be good to mention the skill in AGENTS.md

@alex-rawlings-yyc reviewed 2 files and all commit messages, and made 1 comment.
Reviewable status: complete! all files reviewed, all discussions resolved (waiting on jasonleenaylor).

[imnasnainaec]

@imnasnainaec reviewed 1 file and all commit messages, and made 1 comment.
Reviewable status: all files reviewed, 1 unresolved discussion (waiting on jasonleenaylor).

---

.claude/skills/comment-rules/SKILL.md line 19 at r1 (raw file):

- Exported methods, classes, interfaces, types, and constants: give a short summary.
- Private/internal symbols: comment only when the purpose is non-obvious. Skip trivial getters, thin wrappers, and self-evident helpers.

We have a stronger statement of full required docs on all functions in the AGENTS.md file, so this and that need to be harmonized. Same as with params/returns below.

[alex-rawlings-yyc]

Looks good to me! I'll defer to @imnasnainaec for approval again

@alex-rawlings-yyc reviewed 2 files and all commit messages, and made 1 comment.
Reviewable status: all files reviewed, 1 unresolved discussion (waiting on jasonleenaylor).

[imnasnainaec]

@imnasnainaec reviewed 1 file and all commit messages, made 1 comment, and resolved 1 discussion.
Reviewable status: all files reviewed, 1 unresolved discussion (waiting on jasonleenaylor).

---

.claude/skills/comment-rules/SKILL.md line 27 at r2 (raw file):
⛏️ There's some risk of ambiguity/confusion with the final sentence of this paragraph. How about changing

If any parameter deserves a comment, document all of them.

to something like

An exception: if any single method parameter deserves a comment, document all the parameters of that method.

[imnasnainaec]

@imnasnainaec reviewed 1 file and all commit messages, and resolved 1 discussion.
Reviewable status: complete! all files reviewed, all discussions resolved (waiting on jasonleenaylor).