Commit-Helper：遵循 Conventional Commits 规范的 Git 提交信息助手

commit-helper by charon-fan/agent-playbook

168 周安装量

23 GitHub Stars

GitHub

安装命令

npx skills add https://github.com/charon-fan/agent-playbook --skill commit-helper

开发自动化代码规范

🇨🇳中文介绍

Commit Message Helper

一个用于创建遵循 Conventional Commits 规范的、格式正确的 Git 提交信息的技能。

技能激活时机

当您进行以下操作时，此技能将被激活：

请求提交更改
提及提交信息
请求 git 提交格式
说“commit”或“git commit”

提交信息格式

<type>(<scope>): <subject>

<body>

<footer>

类型

类型	描述
`feat`	新功能
`fix`	错误修复
`docs`	仅文档更改

广告位招租

在这里展示您的产品或服务

触达数万 AI 开发者，精准高效

联系我们

相关 Skills

FlyClaw：零登录航班聚合查询工具，Python实现多源航班信息与价格搜索

4,000,000 周安装

find-skills 技能搜索工具 - Vercel Labs 开源智能体技能包管理器

843,800 周安装

Vercel React 最佳实践指南 | 58条Next.js性能优化规则与代码重构

278,000 周安装

Vercel Web界面规范检查工具 - 自动检测代码是否符合Web设计指南

224,400 周安装

范围应指明受影响的代码库区域：

对于前端：components、hooks、store、styles、utils
对于后端：api、models、services、database、auth
对于 DevOps：ci、deploy、docker
项目特定的范围也是可以接受的

使用祈使语气（用“add feature”，而不是“added feature”或“adds feature”）
末尾不加句号
最多 50 个字符
具体且简洁

用空行将主题与正文分开
使用正文解释 做了什么 和 为什么，而不是 如何做的
每行最多 72 个字符
提及任何破坏性变更

引用问题：Closes #123、Fixes #456、Refs #789
多个问题：Closes #123, #456, #789
破坏性变更：以 BREAKING CHANGE: 开头，后跟描述

feat(auth): add OAuth2 login support

Implement OAuth2 authentication flow to allow users to log in
with their Google or GitHub accounts.

This change adds:
- New OAuth2 middleware for handling callbacks
- Updated login UI with social login buttons
- User profile synchronization

Closes #123



fix(api): resolve race condition in user creation

The concurrent user creation requests could result in duplicate
email entries. Added unique constraint and proper error handling.

Fixes #456



refactor(user): simplify profile update logic

Extracted common validation logic into a reusable function
to reduce code duplication across profile update endpoints.



docs: update API documentation with new endpoints

Added documentation for the v2 user management endpoints
including request/response examples and error codes.

updated stuff                    # 太模糊，没有类型/范围
fixed bug                        # 没有说明是哪个错误
feat: added feature              # 冗余（"feat" 意味着新功能）
Feat(User): Add Login            # 大小写不正确
feat: A really really really long subject line that exceeds the recommended limit  # 太长

当引入破坏性变更时，在页脚添加 BREAKING CHANGE:：

feat(api): migrate to REST v2

The API endpoints have been restructured for better consistency.
Old endpoints are deprecated and will be removed in v3.0.

BREAKING CHANGE: `/api/v1/users` is now `/api/v2/users`.
All consumers must update their integration by 2025-03-01.

撰写提交信息时：

审查更改 - 运行 git diff 以了解更改内容
确定类型 - 确定更改的类型
确定范围 - 确定受影响的区域
撰写主题行 - 创建清晰、简洁的主题行
撰写正文 - 解释做了什么和为什么（如果需要）
添加页脚 - 引用问题或注明破坏性变更

使用验证脚本检查提交信息格式：

python scripts/validate_commit.py "your commit message"

完整规范请参见 references/conventional-commits.md
更多示例请参见 references/examples.md
推荐的范围命名请参见 references/scopes.md

🇺🇸English

Commit Message Helper

A skill for creating properly formatted Git commit messages following the Conventional Commits specification.

When This Skill Activates

This skill activates when you:

Ask to commit changes
Mention commit messages
Request git commit formatting
Say "commit" or "git commit"

Commit Message Format

<type>(<scope>): <subject>

<body>

<footer>

Types

Type	Description
`feat`	A new feature
`fix`	A bug fix
`docs`	Documentation only changes
`style`	Changes that do not affect the meaning of the code (formatting, etc.)
`refactor`	A code change that neither fixes a bug nor adds a feature
`perf`	A code change that improves performance
`test`	Adding missing tests or correcting existing tests
`chore`	Changes to the build process or auxiliary tools
`ci`	Changes to CI configuration files and scripts
`build`	Changes that affect the build system or external dependencies

Scope

The scope should indicate the area of the codebase affected:

For frontend: components, hooks, store, styles, utils
For backend: api, models, services, database, auth
For devops: ci, deploy,

Guidelines

Subject Line

Use imperative mood ("add feature" not "added feature" or "adds feature")
No period at the end
Maximum 50 characters
Be specific and concise

Body

Separate subject from body with a blank line
Use the body to explain what and why , not how
Wrap at 72 characters per line
Mention any breaking changes

Footer

Reference issues: Closes #123, Fixes #456, Refs #789
Multiple issues: Closes #123, #456, #789
Breaking changes: Start with BREAKING CHANGE: followed by description

Examples

Good Examples

feat(auth): add OAuth2 login support

Implement OAuth2 authentication flow to allow users to log in
with their Google or GitHub accounts.

This change adds:
- New OAuth2 middleware for handling callbacks
- Updated login UI with social login buttons
- User profile synchronization

Closes #123



fix(api): resolve race condition in user creation

The concurrent user creation requests could result in duplicate
email entries. Added unique constraint and proper error handling.

Fixes #456



refactor(user): simplify profile update logic

Extracted common validation logic into a reusable function
to reduce code duplication across profile update endpoints.



docs: update API documentation with new endpoints

Added documentation for the v2 user management endpoints
including request/response examples and error codes.

Bad Examples

updated stuff                    # Too vague, no type/scope
fixed bug                        # No context about which bug
feat: added feature              # Redundant ("feat" means new feature)
Feat(User): Add Login            # Incorrect capitalization
feat: A really really really long subject line that exceeds the recommended limit  # Too long

Breaking Changes

When introducing breaking changes, add BREAKING CHANGE: to the footer:

feat(api): migrate to REST v2

The API endpoints have been restructured for better consistency.
Old endpoints are deprecated and will be removed in v3.0.

BREAKING CHANGE: `/api/v1/users` is now `/api/v2/users`.
All consumers must update their integration by 2025-03-01.

Workflow

When writing a commit message:

Review changes - Run git diff to understand what changed
Identify type - Determine the type of change
Identify scope - Determine which area is affected
Write subject - Create a clear, concise subject line
Write body - Explain what and why (if needed)
Add footer - Reference issues or note breaking changes

Validation

Use the validation script to check commit message format:

python scripts/validate_commit.py "your commit message"

Reference Documents

See references/conventional-commits.md for full specification
See references/examples.md for more examples
See references/scopes.md for recommended scope naming

Weekly Installs

Repository

charon-fan/agen…playbook

GitHub Stars

First Seen

Jan 22, 2026

Security Audits

Gen Agent Trust HubFail SocketPass SnykPass

Installed on

codex40

gemini-cli40

opencode40

cursor39

github-copilot36

amp35

agent-browser 浏览器自动化工具 - Vercel Labs 命令行网页操作与测试

152,900 周安装

Project-specific scopes are also acceptable

Commit-Helper：遵循 Conventional Commits 规范的 Git 提交信息助手

🇨🇳中文介绍

Commit Message Helper

技能激活时机

提交信息格式

类型

相关 Skills

范围

指南

主题行

正文

页脚

示例

良好示例

不良示例

破坏性变更

工作流程

验证

参考文档

🇺🇸English

Commit Message Helper

When This Skill Activates

Commit Message Format

Types

Scope

Guidelines

Subject Line

Body

Footer

Examples

Good Examples

Bad Examples

Breaking Changes

Workflow

Validation

Reference Documents

最新 Skills