conventional-comments

Generate code review comments in the Conventional Comments format.

Updated Jan 10, 2025
One-click install
npx skills add https://github.com/hairihou/dotfiles --skill conventional-comments
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: conventional-comments
Source: https://github.com/hairihou/dotfiles/tree/main/src/.claude/skills/conventional-comments
Command: npx skills add https://github.com/hairihou/dotfiles --skill conventional-comments

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps you write code review comments in the Structured Conventional Comments format, ensuring reviews are clear, actionable, and consistent across teams.

Core Features & Use Cases

  • Standardized feedback aligned with Conventional Comments for faster reviews.
  • Clear labeling of issues, suggestions, questions, and notes.
  • Templates and examples to guide reviewers and reduce ambiguity.

Quick Start

Ask Claude to generate a Conventional Comment for a failing null-check, labeled as todo, with a brief suggested fix.

Frequently Asked Questions about conventional-comments

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I write structured code review comments that are consistent across my team?

Conventional Comments format standardizes feedback with required labels (issue, suggestion, todo, question, note, typo), optional blocking indicators (!), and optional decorations (security, performance, a11y, ux). This ensures reviewers communicate intent clearly and reduces ambiguity in code reviews across all projects and languages.

What labels should I use for different types of code review feedback?

Conventional Comments defines six labels: issue for bugs or problems, suggestion for improvements, todo for follow-up work, question for clarification, note for informational comments, and typo for spelling or formatting fixes. Each label signals the feedback's intent, making reviews faster to scan and act on.

Can I mark code review comments as blocking or add priority indicators?

Yes. Conventional Comments supports an optional blocking flag (!) to indicate feedback that must be addressed before merge, and optional decorations like security, performance, a11y, and ux to highlight the comment's impact category. This makes critical feedback immediately visible.

How do I enforce consistent code review comment formatting across my team?

Conventional Comments syntax validation ensures required parts (label and subject) are present, supports optional blocking flags and decorations, and restricts labels to the allowed set. Generating comments in this format creates a standardized baseline that all reviewers can follow.

Does Conventional Comments work with code reviews in all programming languages?

Yes. Conventional Comments is language-agnostic and applies to code review workflows across any language or project. The format itself is independent of syntax, making it suitable for polyglot teams and codebases.

What information should I include in a structured code review comment?

Conventional Comments require a label and subject line. Optionally add a blocking indicator (!), decorations (security, performance, a11y, ux) to signal impact, and discussion text with context or suggested fixes. This structure keeps feedback actionable and unambiguous.