SuperAPI AI 工具集

git-storytelling-commit-messages

通用与其它

查看项目

更新于 10-16 03:35

技能介绍

用途:该技能用于在编写 Git 提交信息时,让信息清晰传达变更内容并讲述开发过程的故事。提交信息被视为随代码共存的文档,服务于未来的开发者、代码审查者、项目管理者和自动化工具等读者。

主要能力:提供三部分结构(主题行、正文、页脚)的写作规范。主题行格式为 <type>: <description>,使用命令式语气、50 字符以内、不以句号结尾、冒号后首字母大写。类型前缀包括 feat、fix、docs、refactor、test、perf、style、chore。正文说明变更内容、原因、副作用与上下文,72 字符换行,与主题行之间空一行。页脚可包含 Refs、Closes、Breaking Change 和 Co-Authored-By。资料还给出多组件变更、带测试的缺陷修复、破坏性变更、性能优化、安全修复、配置变更和回滚等示例写法,以及最佳实践与常见陷阱。

使用方式:资料提供检查提交信息的命令,例如 git log --oneline -10、git show HEAD、git log --format="%h %s" | awk 'length($0) > 52 { print }'、git log main..HEAD --format="%B"、git log --author="Your Name" --format="%h %s"。同时给出创建提交信息模板的方法:写入 ~/.gitmessage 后执行 git config --global commit.template ~/.gitmessage;并提供一个 commit-msg 钩子脚本示例,用于校验类型前缀与主题行长度。相关技能包括 git-storytelling-commit-strategy、git-storytelling-branch-strategy 和 code-reviewer。

适用场景:在任意代码变更中编写提交信息、开发过程中创建提交、为代码审查准备提交、参与开源项目、团队共享 Git 历史的项目、记录重要技术决策、生成发布说明或变更日志、使用 git bisect 调试以及建立团队 Git 约定。

限制:资料未说明该技能的收费、价格、平台支持范围或实际效果;其具体安装方式在给定资料中暂未提供。使用前应结合所在仓库的既有约定,不编造未提及的功能。