ruby-commit-message

Ruby Commit Message 是一个面向 Ruby 及 Ruby on Rails 项目的提交信息撰写指南技能。当需要提交代码变更时，它帮助开发者按照 Conventional Commits 规范组织提交信息，使提交记录结构清晰、便于回溯。\n\n主要能力与内容：\n\n格式方面，技能规定提交信息采用 <type>(<scope>): <subject> 的标题结构，后接正文与页脚，各部分之间以空行分隔。\n\n提交类型速查表覆盖 feat（新功能）、fix（缺陷修复）、refactor（重构，不改变行为）、perf（性能改进）、docs（仅文档）、test（测试新增或修正）、build（构建系统或依赖）、ci（CI 配置）、chore（维护任务）、style（代码格式，无逻辑变化）、revert（回滚提交）、meta（仓库元数据）、license（许可证变更）。\n\n标题行规则要求使用祈使语气（如 Add、Fix、Update、Remove）、现在时、首字母大写、结尾不加句号、最长 70 个字符；scope 为可选，用于说明代码库的具体部分，如 (api)、(auth)。\n\n正文指南建议用几句简洁的话，按 72 字符换行，在标题后留空行；写作对象是初级 Ruby 开发者，语言应简单易懂，便于其在调试时理解变更。正文应说明 WHY（动机、问题或用户影响，可结合已有上下文）、简要说明 WHAT 改了什么（HOW 已由代码差异体现），仅在代码或命名无法体现时补充 HOW 细节；有上下文支持时可指出权衡取舍，不得编造细节。\n\n页脚与 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”之类内容。\n\n技能还给出示例，包括安全与授权修复（限制报告访问范围）、新功能（Slack 线程回复）以及破坏性变更（移除废弃的 v1 接口），并列出常见错误及其修正方式，例如正文只讲 HOW 而缺乏上下文、标题描述实现而非意图、正文重复代码差异、标题超过 70 字符以及在正文中写“Generated by AI”等。\n\n适用场景为 Ruby/Rails 项目日常提交代码时的信息撰写与规范检查。限制方面，该技能仅针对提交信息内容与格式，不涉及代码审查或自动化提交工具；具体安装与调用方式暂未提供。