用途
该技能用于在 Git 仓库中创建原子化、面向产品的提交。它帮助开发者将工作区中的变更组织成一系列可审查的提交,每个提交记录一个产品或架构成果,并包含足够的推理信息,以便未来的读者理解变更的意图。
主要能力
- 提供从盘点工作区到创建提交的完整工作流程。
- 指导如何规划提交顺序,按依赖关系和审查者的学习路径排列。
- 强调每个提交只包含一个逻辑成果,并包含相关的测试和文档。
- 提供提交信息的结构规范,包括主题和正文的撰写要求。
- 强调历史安全,将已发布的历史视为不可变。
使用方式
该技能定义了一个六步工作流程:
- 盘点工作区:检查
git status --short、git diff和git diff --cached,识别生成的文件、无关的编辑和应保持未提交的变更。 - 规划故事:按依赖关系和审查者的学习路径排列提交顺序。每个提交只包含一个逻辑成果,即使多个成果涉及同一文件也要拆分。如果计划多个提交,在暂存前说明提议的顺序。
- 暂存一个单元:使用
git add path/to/file或git add -p暂存确切的路径或补丁,然后检查暂存结果git diff --cached --stat和git diff --cached。 - 验证暂存的变更:运行仓库相关的测试、linter 或检查。选择覆盖该提交的最窄检查,并在项目要求时添加更广泛的检查。
- 撰写并创建提交:使用指定的结构撰写提交信息。主题以 Add、Update、Remove 或 Delete 开头,使用现在时,描述具体成果,优先控制在 72 个字符以内。正文用于解释原因、影响或权衡,使用项目符号列出不同的决策。避免实现清单、常规测试添加和 AI 署名。在提交前,再次阅读暂存的差异,并从中推导出提交信息。
- 验证并继续:每次提交后,检查
git status --short和新提交。重复工作流程处理下一个计划单元。
适用场景
该技能适用于任何需要准备、撰写或重新组织 Git 提交的场景。它特别适合需要创建可审查的提交序列、确保每个提交独立可理解、以及需要记录变更意图和推理的项目。
限制
- 该技能不涉及具体的代码实现或测试框架。
- 历史安全部分强调,仅在用户请求历史编辑并确认提交可安全重写时,才进行重排、压缩、修改或强制推送。优先使用
--force-with-lease而非--force。 - 该技能未提供具体的收费、价格或平台信息。
- 该技能未提供官方文本或额外的示例内容,仅提及可阅读 EXAMPLES.md 获取更多示例。