Git 提交信息生成器。根据代码变更内容自动生成符合 Conventional Commits 规范的提交信息,包含类型、范围、简短描述、详细说明和关联的 Issue/需求号。触发词:生成提交信息、提交信息、commit message、git commit、生成 commit 信息
Git 提交信息生成器
功能概述
Git 提交信息生成器是一项面向实际任务的技能,主要用于根据代码变更内容,自动生成符合 Conventional Commits 规范的 Git 提交信息;完成代码修改后,需要生成规范的提交信息;
核心要点
- 团队要求遵循 Conventional Commits 规范;
- 需要关联 Issue 或需求号;
- 不确定提交信息应该如何撰写;
使用与执行
Step 1: 接收变更描述;用户可以通过以下方式提供变更内容:;文字描述变更内容;粘贴 git di。它将相关步骤、工具调用和结果整理方式集中到统一流程中,帮助使用者更快完成目标并减少重复操作。
结果检查与注意事项
从功能定位来看,该技能强调把分散的操作要求整理成清晰、可复用的处理流程,使用户能够围绕既定目标快速准备输入、选择执行方式并获得结构化结果。实际使用前应先确认任务范围、数据来源、运行环境、必要权限和关键参数,再依据技能说明逐步执行;若输入条件不完整,应先补齐信息或采用保守配置,避免因错误假设导致结果偏离需求。执行过程中需要关注工具调用是否成功、接口或依赖是否可用、输出格式是否符合预期,并对异常提示、缺失字段和边界情况进行处理;涉及批量任务时,还应保存进度,避免中断后重复操作。
Git 提交信息生成器
根据代码变更内容,自动生成符合 Conventional Commits 规范的 Git 提交信息。
何时使用
- 完成代码修改后,需要生成规范的提交信息
- 团队要求遵循 Conventional Commits 规范
- 需要关联 Issue 或需求号
- 不确定提交信息应该如何撰写
处理流程
Step 1: 接收变更描述
用户可以通过以下方式提供变更内容:
- 文字描述变更内容
- 粘贴
git diff输出 - 列出修改的文件和功能点
Step 2: 分析变更类型
使用 scripts/generate_commit_message.py 自动分析:
scripts/generate_commit_message.py "用户输入的变更描述"
自动识别变更类型:
| 类型 | 说明 | 关键词 |
|---|---|---|
| feat | 新功能 | 新增、添加、feature |
| fix | 修复 Bug | 修复、bug、问题 |
| docs | 文档 | 文档、readme、注释 |
| style | 格式 | 格式、空格、lint |
| refactor | 重构 | 重构、整理、清理 |
| perf | 性能优化 | 性能、优化、加速 |
| test | 测试 | 测试、unit、用例 |
| chore | 杂项 | 配置、构建、工具 |
Step 3: 提取影响范围
自动识别模块/范围:
- 从文件路径提取(如
src/algorithm/→algorithm) - 从代码内容识别(类名、函数名)
- 匹配常见模块名
Step 4: 生成提交信息
生成符合规范的提交信息:
( ):
Step 5: 输出和复制
输出格式化的提交信息,用户可直接:
- 复制到剪贴板
- 用于
git commit命令 - 粘贴到 Git 工具中
提交信息结构
标准格式
feat(algorithm): 增加缓冲液单人份独立配置 - 新增配置项"单人份缓冲液量",用于精确计算消耗 - 修改稀释逻辑,支持按实际人份计算而非固定倍数 - 更新相关接口文档 Closes #234
各部分说明
主题行(Subject)
- 格式:
( ): - 长度:≤50 字符
- 时态:一般现在时
- 大小写:首字母小写
正文(Body)
- 说明为什么修改,而非修改了什么
- 每行≤72 字符
- 可包含多个变更点
页脚(Footer)
- Issue 关闭:
Closes #123 - 破坏性变更:
BREAKING CHANGE: ... - 联合作者:
Co-authored-by: ...
使用示例
示例 1:新功能
用户输入:
生成提交信息:新增缓冲液单人份配置功能,支持精确计算消耗量,需求号 234
输出:
feat(algorithm): 增加缓冲液单人份独立配置 - 新增配置项"单人份缓冲液量" - 修改稀释逻辑,支持按实际人份计算 Closes #234
示例 2:Bug 修复
用户输入:
修复试剂仓传感器数据读取偶发失败的问题,添加重试机制
输出:
fix(sensor): 修复试剂仓传感器数据读取偶发失败 - 添加重试机制(最多 3 次) - 增加超时处理 - 完善错误日志 影响:修复问题,建议尽快合并
示例 3:重构
用户输入:
重构稀释模块代码,提高可读性,无功能变化
输出:
refactor(dilution): 重构稀释模块代码提高可读性 - 拆分大函数为多个小函数 - 提取公共逻辑到工具类 - 添加单元测试覆盖 影响:代码重构,功能不变
示例 4:带 git diff
用户输入:
生成提交信息 diff --git a/src/core/algorithm.py b/src/core/algorithm.py + def calculate_reagent_volume(): + """计算试剂用量""" + pass
输出:
feat(core): 新增试剂用量计算函数 - 新增 calculate_reagent_volume 函数 - 实现试剂用量计算逻辑 影响:新功能,不影响现有功能
参考文档
详见 references/conventional-commits.md - Conventional Commits 完整规范
详见 references/commit-examples.md - 提交信息示例集合
注意事项
- 主题行简洁 - 50 字符以内,一眼看懂变更
- 说明为什么 - 正文重点说明修改原因,而非内容
- 关联 Issue - 有需求号一定要关联,便于追溯
- 破坏性变更 - 如有 API 不兼容修改,必须标注 BREAKING CHANGE
- 原子提交 - 一次提交只做一件事,便于回滚和审查
团队规范建议
## 提交规范 1. 使用 Conventional Commits 2. 主题行 50 字符以内 3. 正文说明为什么修改 4. 关联 Issue 号 5. 破坏性变更必须标注
热门AI工具
相关专题
要对比两个版本的 git 文件,请使用 git diff 命令:git diff 比较工作树和暂存区之间的差异。git diff 比较两个提交或标签之间的差异。git diff 输出显示差异块,其中 + 表示添加的行,- 表示删除的行, 表示修改的行。可使用 gitkraken、meld、beyond compare 等可视化工具更直观地查看差异。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。
2281
2024.04.09
git提交错误撤回的方法:git reset head^:撤回最后一次提交,恢复到提交前状态。git revert head:创建新提交,内容与之前提交相反。git reset :使用提交的 sha-1 哈希撤回指定提交。交互式舞台区:标记要撤回的特定更改,然后提交,排除已撤回更改。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。
2517
2024.04.09
Git是一个强大的版本控制系统,它提供了很多功能帮助开发人员有效地管理和控制代码的变更,本专题为大家提供git 撤销提交的commit相关的各种文章内容,供大家免费下载体验。
714
2023.07.24
git和svn的区别:1、定义不同;2、模型类型不同;3、存储单元不同;4、是否拥有全局版本号;5、内容完整性不同;6、版本库不同;7、克隆目录速度不同;8、分支不同。php中文网为大家带来了git和svn的相关知识、以及相关文章等内容。
1260
2023.07.06
本专题介绍Gradle插件开发的基本流程,涵盖插件类编写、自定义任务注册、扩展参数设计和插件应用方法,帮助你理解插件如何组织构建逻辑,减少多个项目之间的重复配置。
0
2026.10.22
本专题介绍Gradle Wrapper的基本作用,涵盖文件组成、生成方法、版本配置和任务调用,帮助你理解项目如何使用指定的Gradle版本,减少不同开发环境带来的构建差异。
0
2026.10.22
本专题整理Golangci-lint常用Linters的用途与配置方法,覆盖错误处理、无效代码、安全、复杂度、命名和依赖检查,帮助项目合理选规则。
0
2026.10.22
本专题介绍Gradle Java项目构建方法,涵盖Java插件配置、依赖声明、源码编译、测试执行和打包检查,帮助你理解各阶段的任务关系,逐步完成项目构建。
0
2026.10.22
热门下载
相关下载
