Conventional Commit 技能用于按照 Conventional Commits 规范生成与校验提交信息。
用途 当用户希望提交代码、提到 commit,或粘贴提交信息请求校验时使用。它帮助生成符合 conventionalcommits.org 规范的提交信息,并对已有信息进行格式检查。
提交信息格式 <type>(<scope>): <subject>
[optional body]
[optional footer(s)]
类型(Types)
- feat:新功能
- fix:缺陷修复
- docs:仅文档
- style:代码风格(格式化、分号等)
- refactor:既不修复也不新增的代码改动
- test:新增或更新测试
- chore:构建、工具、依赖
- perf:性能改进
- ci:CI 配置变更
- build:构建系统或依赖
- revert:回滚此前的提交
规则
- Subject:简短描述,祈使语气,小写,结尾不加句号
- Scope:可选,小写,描述改动的区域(如 auth、api、ui)
- 破坏性变更:在 type/scope 后加 !,例如 feat(auth)!: change API
- Footer:用于破坏性变更(BREAKING CHANGE:)或 issue 引用(Closes #123)
操作
- 从 diff 生成提交信息 当用户想提交变更时:
- 运行 git status 查看变更文件
- 运行 git diff --staged 查看已暂存变更
- 分析改动以确定:Type(哪种类型最贴切)、Scope(受影响的区域,可选)、Subject(做了什么,使用祈使语气,如用 "add" 而非 "added")
- 生成 conventional commit 信息
- 运行 git commit -m "<message>"
示例: feat(auth): add JWT token refresh
Implements token refresh endpoint to extend sessions without requiring re-authentication.
Closes #142
- 校验提交信息 当用户要求校验或检查提交信息时:
- 解析提交信息
- 检查格式:<type>(<scope>): <subject>
- 校验 type 是否在允许列表中
- 检查 subject 是否符合规则(小写、祈使语气、无句号)
- 标记发现的问题
输入方式
- 用户说 "commit" 或 "git commit":从 git diff 生成,然后提交
- 用户说 "validate commit":检查提交信息格式
- 用户粘贴提交信息:校验所提供的信息
自动提交流程 生成提交时:
- 先向用户展示提交信息
- 提交前请求确认(除非用户明确说 "just do it")
- 确认后执行 git commit -m "<message>"
- 展示提交结果
错误处理
- 若无暂存变更:git status 无内容 → 提示用户没有可提交内容
- 若未初始化 git:初始化仓库或提示用户
- 若提交失败:显示错误并提供重试
示例 输入:"I fixed the login bug" 输出: fix(auth): resolve login timeout issue
Users were logged out after 5 minutes due to incorrect token expiry calculation.
输入:"I added a new API endpoint for users" 输出: feat(api): add user profile endpoint
GET /users/:id returns user profile data including name, email, and avatar URL.
Closes #89
输入:"I changed the auth API, this breaks old clients" 输出: feat(auth)!: change token validation endpoint
The /auth/verify endpoint now requires Bearer token instead of query parameter.
BREAKING CHANGE: Clients must update to send Authorization header with Bearer token.