关于 commit-helper
此技能分析已暂存的 Git 变更,并按 Conventional Commits 格式起草包含摘要和说明正文的提交信息,适用于准备提交的开发者。
主要功能
- 01分析已暂存的 Git 变更
- 02选择 Conventional Commits 类型
- 03添加可选作用域
- 04起草摘要和说明正文
适用场景
- 01根据暂存变更撰写提交信息
- 02记录修复、功能或文档更新
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ nodnarbnitram/ claude-code-extensions --skill commit-helper安装后在 Claude Code 中输入/commit-helper确认已加载。
详细介绍
提交助手
按照 Conventional Commit 格式生成结构良好的提交消息。
说明
- 运行
git diff --staged查看已暂存的更改 - 分析更改,以了解:
- 修改了哪些文件
- 更改类型(feat、fix、refactor、docs 等)
- 受影响的范围或组件
- 生成提交消息,包含:
- 不超过 50 个字符的摘要行
- 类型前缀(feat、fix、docs、refactor、test、chore)
- 可选的括号内范围
- 说明更改内容及原因的详细正文
提交类型
feat:新功能fix:错误修复docs:文档更改refactor:重构代码,不改变行为test:添加或更新测试chore:维护任务
最佳实践
- 使用现在时(“Add feature”,而不是“Added feature”)
- 说明更改内容及原因,而非实现方式
- 保持摘要简洁明了
- 适用时引用问题编号
输出示例
feat(auth): add OAuth2 support for GitHub login
- Implement OAuth2 flow with PKCE
- Add token refresh mechanism
- Store tokens securely in encrypted storage
Closes #123
评论
支持 Markdown