使用方法
- 复制安装命令,在自己的智能体环境安装前先检查源码包。
- 从原始文档核对所需工具、凭据和支持的宿主。
- 说明输入材料与期望交付物,并对照来源检查输出。
npx skills add https://github.com/filstawski/playbook --skill git-commit-messages开始前需了解
- 安装不包含模型订阅、API 额度或访问文件的权限。
- 仓库星数和安装量反映活跃情况,不等于独立质量或安全测试。
按源仓库内容呈现,保留标题、案例、代码、表格、链接以及原文引用的演示图片。
Rule
- First line:
<type>(<optional scope>): <summary>— imperative
present tense ("add", not "added" or "adds"), under ~70 characters, no trailing period.
- Type is whichever of these best matches the primary change:
feat, fix, docs, refactor, test, chore, build, ci, perf, style. If a change genuinely needs two types, that's two commits, not one commit picking the closer-sounding type.
- Scope (the optional
(scope)part) names the affected area only
when the repo is big enough that it actually disambiguates (feat(auth): ... in a large app). Skip it in a small repo where it adds no information over the summary alone.
- Body (blank line, then prose) explains why the change was made —
the reasoning, the incident, the tradeoff behind it — not a restatement of the diff. The diff already says what changed; the body earns its place only by saying something the diff can't. Omit the body entirely for a change that's genuinely self-explanatory from the summary alone.
- **No AI/assistant attribution lines, ever, unless explicitly asked for in
that instance.** No Co-Authored-By: Claude ..., no "Generated with ...", no session links, no watermark of any kind — regardless of what a tool's default commit template suggests appending. A commit's authorship metadata (the actual git author/committer fields) already records who ran the command; a text watermark in the message body is a separate, unwanted thing.
Examples:
feat: add per-route rate limit override
Some upload endpoints need a much higher ceiling than the global
default; per-route config keeps that from requiring a schema change.fix: stop double-firing the delete audit entrydocs: correct the outdated symlink command in the READMEWhy
Conventional types make git log --oneline and any changelog tooling useful without extra setup, and a fixed format is one less thing to decide per commit. The body's job is specifically to carry information the diff itself cannot — motivation, context, a link to an incident — so a body that just narrates the diff in prose is wasted text nobody will read twice. Attribution/watermark lines are excluded on purpose: a commit is reviewed and authored under my direction as far as the repository's history is concerned, and I don't want that stamped as a permanent, unremovable annotation on every commit going forward just because a tool defaults to adding one.
Exceptions
- A one-off WIP/checkpoint commit on a private branch that will be
squashed before merging doesn't need to follow this — conventional formatting is for commits that will actually live in shared history.
- If a project's existing history already uses a different, established
convention (a team-wide scope list, a differently-shaped format), match that existing convention instead of imposing this one on a shared repo whose conventions aren't mine to unilaterally change.
See also
- git-commit-requires-approval — whether a commit should happen at all, which comes before how it's worded.