关于 commit
这项技能指导开发者按 Conventional Commits 规范创建 Git 提交,涵盖变更检查、类型与范围选择,以及简洁主题和说明正文的写法。
主要功能
- 01Conventional Commits 类型与格式
- 02主题和正文撰写规范
- 03可选范围与破坏性变更标记
- 04提交前检查暂存变更
适用场景
- 01规范功能或修复类提交
- 02在提交中说明破坏性变更
- 03提交前检查暂存文件
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ nweii/ agent-stuff --skill commit安装后在 Claude Code 中输入/commit确认已加载。
详细介绍
提交
按照 Conventional Commits 创建格式规范的 git 提交。
格式
<type>[optional scope]: <description>
[optional body]
[optional footer(s)]
类型
feat:新增功能fix:修复错误docs:仅修改文档style:格式调整、缺少分号等(不修改代码)refactor:既不修复错误也不新增功能的代码修改perf:性能优化test:补充缺失的测试chore:维护任务(构建流程、依赖等)
指南
- 主题行:使用祈使语气(“add”,而不是“added”);建议不超过 50 个字符。
- 正文:每行不超过 72 个字符;说明是什么以及为什么,而非如何做。
- 范围:可选,用于指明代码库中的相关部分(例如
feat(auth):)。 - 破坏性变更:在类型/范围后添加
!(例如feat!:),并在页脚中说明。
流程
- 查看暂存的更改(
git diff --staged)和未提交的git status。 - 如果
git add -A可能会纳入机密信息或无关工作,请明确暂存文件。 - 选择合适的类型和范围。
- 编写简洁的主题;如果更改不言自明,则无需添加正文。
示例
feat(auth): add OAuth2 login support
Implements Google and GitHub OAuth providers.
Closes #123
fix: resolve race condition in data fetcher
The previous implementation could return stale data
when multiple requests were in flight.
chore: update dependencies to latest versions
评论
支持 Markdown