关于 genshijin-commit
为使用 genshijin 的开发者提供 Conventional Commits 提交信息编写规范,强调简洁说明原因,并禁止执行提交或暂存操作。
主要功能
- 01Conventional Commits 格式
- 02规范标题类型与长度
- 03按需撰写正文说明原因
- 04限制生成信息,不执行提交
适用场景
- 01为功能或修复编写提交标题
- 02说明破坏性变更或迁移注意事项
- 03按仓库历史选择日文或英文
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ interfacex-co-jp/ genshijin --skill genshijin-commit安装后在 Claude Code 中输入/genshijin-commit确认已加载。
详细介绍
提交信息应简洁准确。采用 Conventional Commits 格式。禁止冗长。「为什么」比「做什么」更重要。
规则
标题
<type>(<scope>): <命令式摘要>—<scope>可选- types:
feat、fix、refactor、perf、docs、test、chore、build、ci、style、revert - 使用命令式:「添加」「修复」「删除」——不可使用「已添加」「将添加」
- 目标 ≤50 个字符,上限 72 个字符
- 末尾无需句号
- 日语/英语应与仓库现有提交历史保持一致(检查
git log)
正文(仅在需要时)
- 如果标题已清楚说明,则省略
- 添加正文时,说明:
- 不明显的「为什么」
- 破坏性变更
- 迁移注意事项
- 相关 Issue/PR
- 每行 72 个字符换行
- 项目符号使用
-(不使用*) - 末尾添加 Issue/PR 引用:
Closes #42Refs #17
绝对不要加入
- 「此提交将……」「我」「我们」「当前」「现在」——查看 diff 即可明白
- 「应某某要求」——使用
Co-authored-bytrailer - 「Generated with Claude Code」等 AI 署名信息
- 表情符号(除非项目惯例要求)
- 在 scope 中重复写出已出现的文件名
示例
diff:新增用户个人资料端点,在正文中说明原因
- ❌
feat: 新增从数据库获取用户个人资料信息的端点 - ✅
feat(api): GET /users/:id/profile 追加 モバイルクライアント コールドスタート時 LTE帯域削減のため、完全user payload不要なprofileデータ 取得エンドポイントが必要。 Closes #128
diff:破坏性 API 变更
- ✅
feat(api)!: /v1/orders を /v1/checkout にリネーム BREAKING CHANGE: /v1/orders クライアント 2026-06-01 までに /v1/checkout 移行必須。以降旧ルート 410 返却。
diff:小型错误修复(无需正文的示例)
- ✅
fix(auth): 修复令牌过期检查的边界条件
自动明晰
以下情况禁止仅写标题,必须添加正文:
- 破坏性变更
- 安全修复
- 数据迁移
- revert 提交
未来的调试人员需要上下文。不要过度压缩。
边界
- 仅生成信息。不执行
git commit、暂存或 amend - 输出为可粘贴的代码块格式
- 输入「原始人提交信息别再写了」或「普通模式」即可解除
评论
支持 Markdown