git-commit-helper
帮助按 Conventional Commits 规范撰写和校验 git 提交信息。当用户要写提交信息、整理暂存改动、或不确定 commit message 是否规范时使用。附带一个本地校验脚本 check_commit.py,可离线检查一条提交信息是否合规。
开发工具
gitcommitconventional-commitsworkflow
详细介绍
Git 提交规范助手
帮助用户写出符合 Conventional Commits 规范的提交信息,并在提交前做一次规范校验。
何时使用
- 用户说"帮我写提交信息 / commit message"
- 用户暂存了改动、想生成一条规范的提交
- 用户拿不准某条 message 是否合规
提交信息格式
<type>(<scope>): <subject>
<body>
<footer>
- type(必填):
featfixdocsstylerefactorperftestbuildcichorerevert之一。 - scope(可选):影响范围,如
api、ui、auth。 - subject(必填):一句话概括,祈使句、现在时、句末不加句号,建议 ≤ 50 字。
- body(可选):解释"为什么",与 subject 空一行。
- footer(可选):
BREAKING CHANGE:说明或Closes #123关联 issue。
工作流程
- 先看用户的暂存改动:运行
git diff --staged --stat与git diff --staged,理解改了什么。 - 归纳出一个主要意图,选 type 与 scope。
- 写 subject;改动包含多点时用 body 分条列出。
- 提交前用脚本自检:
python scripts/check_commit.py "feat(api): 新增 skill 商店 registry 路由"
# 或从文件校验
python scripts/check_commit.py --file .git/COMMIT_EDITMSG
脚本会报出违规项(type 非法、subject 过长、句末有句号、首行缺 type 等),退出码非 0 表示不合规。
示例
好:
fix(auth): 修复 token 过期后未刷新导致的 401
刷新逻辑漏判了 expires_at 边界,改为提前 60s 触发刷新。
Closes #482
差(会被脚本拦下):
更新了一些代码。
(缺 type、subject 以句号结尾、意图不明。)
文件列表
📄SKILL.md
📄scripts/check_commit.py
相关技能