conventional-comments
Write structured code review comments using Conventional Comments format. Use when reviewing PRs, writing code review feedback, or asked to "comment on this code" or "review this PR".
安装与使用
请根据来源仓库和你的 AI 工具说明安装此技能。先阅读技能文件和依赖要求，再添加到工作流。
查看来源 ↗使用指南技能说明
Conventional Comments
Write code review comments in Conventional Comments format (https://conventionalcomments.org).
Format
<label>[!] [(decorations)]: <subject>
[discussion]
| Part | Required | Description |
|---|---|---|
label |
Yes | Comment type (see Labels below) |
! |
No | Blocking indicator—must resolve before approval |
(decoration) |
No | Comma-separated context tags (e.g., (security)) |
subject |
Yes | Main message (1 line) |
discussion |
No | Additional reasoning or suggested fix (1-3 lines) |
Labels
| Label | Description |
|---|---|
issue |
Identifies a problem that needs to be addressed. |
suggestion |
Proposes an improvement with an explicit change. |
todo |
Small, necessary change. Less severe than an issue. |
question |
Seeks clarification or investigation. |
note |
Information for the reader. Does not require action. |
typo |
Points out a typographical error. |
Do NOT use: praise, nitpick, quibble — focus on actionable feedback only.
Decorations
| Decoration | Use when |
|---|---|
(security) |
Comment relates to security vulnerabilities. |
(performance) |
Comment relates to performance impact. |
(a11y) |
Comment relates to accessibility. |
(ux) |
Comment relates to user experience. |
Examples
Basic suggestion
suggestion: Consider using optional chaining here.
`user && user.profile && user.profile.name` can be simplified to `user?.profile?.name`.
Blocking issue
issue!: This function silently swallows exceptions.
Either log the error or propagate it to the caller.
With security decoration
suggestion! (security): User input should not be directly embedded in SQL.
Use prepared statements to prevent SQL injection.
With performance decoration
issue (performance): This query runs inside a loop causing N+1 problem.
Batch the IDs and fetch all records in a single query.
Simple todo
todo: Add null check before accessing `user.email`.
Question
question: Is this timeout value intentional?
300ms seems short for API calls that may span regions.
Note (informational)
note: This pattern is also used in `auth-service.ts:45`.
使用示例
查看来源仓库中的使用示例与配置说明。
查看来源 ↗来源历史
- 收录时间
- 2026-01-20
- 索引更新时间
- 2026-01-26
- Branch
- main
收录与同步日期属于本站记录。源码修改历史请查看来源仓库。
GitHub ↗chat Comments (0)
Sign in to join the discussion and leave a comment.
No comments yet. Be the first to share your thoughts!