← ClaudeAtlas

conventional-commentslisted

The Conventional Comments format for review findings — label and decoration syntax, code-directed comment style, and the issue/suggestion/nitpick comment types with literal examples. Load when writing, formatting, or labeling review comments, PR feedback, or reviewer findings.
bostonaholic/team · ★ 11 · AI & Automation · score 75
Install: claude install-skill bostonaholic/team
# Conventional Comments Review comments from the code, security, and docs reviewers use the Conventional Comments format (https://conventionalcomments.org) — the ux-reviewer's live-verification report uses its own Working/Broken/Could Improve format instead. Every comment MUST include a specific `file:line` reference. ## Comment Style Critique the code, not the coder. Assume competence. The same finding can read as collaborative or hostile depending on phrasing: | Avoid (person-directed) | Prefer (code-directed) | |-------------------------|------------------------| | "Your approach is adding unnecessary complexity." | "The complexity this adds is not worth the result." | | "You are not handling the null case." | "The null case is not handled here." | | "This does not make any sense." | "I cannot follow what this branch is doing — clarify?" | - Explain *why* the change is requested. A finding without a reason loses the rationale for the next reader of the diff. - Reserve `issue:` for findings that materially affect correctness, security, or maintainability. Use `suggestion:` or `nitpick:` for preferences. - A high comment density on a single change is a design signal, not just a style problem. When the count climbs past ~10 substantive comments, propose splitting the change or escalating the design conversation out of the review tool. ## Comment Types Every comment body MUST begin with the label and decoration wrapped in `**...**` so GitHub renders it bold.