Agent Skillsawattar/claude-code-best-practices › conventional-commits

conventional-commits

GitHub

用于在编写 Git 提交信息时强制执行项目的 Conventional Commits 规范,确保格式、类型前缀及原子性符合约定。

.claude/skills/conventional-commits/SKILL.md awattar/claude-code-best-practices

Trigger Scenarios

编写 Git 提交消息 生成版本变更记录

Install

npx skills add awattar/claude-code-best-practices --skill conventional-commits -g -y
More Options

Non-standard path

npx skills add https://github.com/awattar/claude-code-best-practices/tree/main/.claude/skills/conventional-commits -g -y

Use without installing

npx skills use awattar/claude-code-best-practices@conventional-commits

指定 Agent (Claude Code)

npx skills add awattar/claude-code-best-practices --skill conventional-commits -a claude-code -g -y

安装 repo 全部 skill

npx skills add awattar/claude-code-best-practices --all -g -y

预览 repo 内 skill

npx skills add awattar/claude-code-best-practices --list

SKILL.md

Frontmatter
{
    "name": "conventional-commits",
    "description": "Use when writing git commit messages in this repository. Enforces the project's conventional commit format — type prefix, GitHub issue reference, and atomic commits — as defined in .gitmessage and .github\/COMMIT_CONVENTION.md."
}

Conventional Commits

When creating any git commit in this repository, follow the project's commit convention. Unlike the /commit command (which the user invokes explicitly), this skill applies automatically whenever a commit message is being authored.

Format

Single-line, when a GitHub issue applies:

<type>: (#<issue_number>) <issue_name> - <description>.

Single-line, when no GitHub issue applies:

<type>: <description>.

Multiline, when the change spans multiple concerns:

<type>: (#<issue_number>) <issue_name>:
- <description_line_1>.
- <description_line_2>.

Rules

  • <type> is exactly one of: New feature, Fix issue, Other.
  • Single-line messages end with .; the first line of a multiline message ends with :.
  • Every bullet starts with - and ends with ..
  • Use present tense, imperative mood ("add feature", not "added feature").
  • Keep commits atomic — one logical concern per commit. Split unrelated changes into separate commits.
  • NEVER add trailers such as "Generated with Claude Code", author info, or co-author lines.

References

  • Full template with examples: .gitmessage
  • Commit-splitting guidance and workflow integration: .github/COMMIT_CONVENTION.md
  • For an interactive, guided commit flow, use the /commit command.

Version History

  • 3456a85 Current 2026-08-02 21:45

Metadata

Files
0
Version
3456a85
Hash
4de271cb
Indexed
2026-08-02 21:45

Главная - Вики-сайт
Copyright © 2011-2026 iteam. Current version is 2.155.2. UTC+08:00, 2026-08-03 04:56
浙ICP备14020137号-1 $Гость$