Git 提交规范生成器
将以下提示词粘贴到你的 AI 对话框中:
请根据 https://skillhub.cn/install/skillhub.md,安装 @user_af163eaa/z-dev-git-commit。
技能介绍
先明确要解决的问题
日常开发中,git commit 的描述常常出现三类问题:一是信息模糊,比如「改了点东西」「修复bug」,后续回溯时难以定位改动意图;二是格式混乱,没有统一规范导致团队协作时历史记录风格不一;三是遗漏关键信息,比如涉及的模块、影响的功能范围未提及,增加了代码审查和问题排查的成本。
技能的核心能力与工作逻辑
这个技能的核心是将「改动描述」转化为符合 Conventional Commits 规范的提交信息,无需记忆复杂规则。触发词包括 git提交、commit规范、git commit、提交信息,触发后按三步处理:
- 理解改动本质:梳理用户提供的改动内容,区分是功能新增、问题修复、文档调整还是其他类型;
- 生成规范信息:按照
类型(可选范围): 简明描述的格式输出,比如「feat(auth): 新增用户登录日志记录功能」; - 补充实用信息:给出生成交信息的关键行注释,说明各部分的含义(如
feat代表新功能,(auth)是涉及的模块),同时提示常见错误(比如类型误用、描述过长)。
适用边界与注意要点
- 该技能仅生成提交信息文本,不替代专业Git工具或团队自定义规范,若团队有专属格式需手动调整;
- 生成的信息需基于清晰的改动描述,若描述模糊可能导致结果偏差;
- 输出仅供参考,执行提交前需结合实际改动验证信息准确性,避免因信息错误导致历史记录混乱。
使用场景
- 开发新功能后,需按规范写git提交信息,确保团队快速理解改动意图
- 修复线上bug时,想生成清晰提交信息,方便后续回溯问题根源
- 团队协作中,需统一git提交格式,避免历史记录风格混乱
- 调整项目文档后,要写符合规范的提交信息,方便查找文档变更记录
适合人员
- 前端/后端开发者,需规范记录功能新增、bug修复等改动,方便团队回溯
- 开源项目贡献者,需遵循社区约定的git提交格式,确保贡献符合规范
- 小团队技术负责人,需统一团队git提交风格,提升代码审查效率
- 刚入职开发者,需学习正确的git提交规范,避免信息模糊导致协作问题