用途:在 Ruby 或 Ruby on Rails 项目中提交代码改动时,指导撰写结构化的提交信息,遵循 Conventional Commits 规范。正文应让初级 Ruby on Rails 开发者在调试时能理解该改动。
格式:<type>(<scope>): <subject>,后接空行、正文、页脚。
提交类型:feat 新功能、fix 缺陷修复、refactor 重构(无行为变化)、perf 性能改进、docs 仅文档、test 测试新增或修正、build 构建系统或依赖、ci CI 配置、chore 维护任务、style 代码格式(无逻辑变化)、revert 回滚、meta 仓库元数据、license 许可证变更。
主题行规则:使用祈使语气(Add、Fix、Update、Remove),现在时(Add feature 而非 Added feature),首字母大写,结尾不加句号,最长 70 字符;scope 可选,用名词描述代码区域,如 (api)、(auth)。
正文指南:几句话,每行 72 字符换行,主题行后空一行。面向初级 Ruby 开发者,用简单语言说明改动影响与原因。WHY 写动机、问题或用户影响;WHAT 简要说明改动(diff 已展示 HOW);HOW 仅在代码或命名未体现时补充。有上下文支持时可指出权衡,不要编造细节。
页脚与 AI 署名:Fixes TICKET-123(或 Fixes #123、Refs TICKET-123);破坏性变更用 BREAKING CHANGE: ...,并在类型后加 !,如 feat(api)!:;AI 生成改动时用 Co-Authored-By: <AI Name> <email>。不要在主题或正文写“Generated by AI”或“Written with Claude”,只用 Co-Authored-By。
常见错误:正文无上下文地解释 HOW;主题描述实现(Changed X to Y)而非祈使句;正文重复 diff 内容;主题超 70 字符;正文出现“Generated by AI”。
限制:资料未提供安装命令、平台支持、收费或价格信息。