深圳外包网站公司,wordpress全站音乐,wap和app,天津建设网工程信息网概述
Git commit message规范是一种良好的实践#xff0c;可以帮助开发团队更好地理解和维护代码库的历史记录。它可以提高代码质量、可读性和可维护性。下面是一种常见的Git commit message规范#xff0c;通常被称为Conventional Commits规范#xff1a;
一…概述
Git commit message规范是一种良好的实践可以帮助开发团队更好地理解和维护代码库的历史记录。它可以提高代码质量、可读性和可维护性。下面是一种常见的Git commit message规范通常被称为Conventional Commits规范
一、Commit message 的格式
每次提交Commit message 都包括三个部分HeaderBody 和 Footer。
type(scope): subject
// 空一行
body其中Header、针对feat和fix类型的提交内容 Body 是必需的。 不管是哪一个部分任何一行都不得超过72个字符或100个字符。这是为了避免自动换行影响美观。
1.1 Header
Header部分只有一行包括三个字段 type必需、scope必需和subject必需。
1type
type用于说明 commit 的类别只允许使用下面7个标识。
feat新功能featurefix修补bugdocs文档documentationstyle 代码样式的变更例如格式化不影响代码运行的变动refactor重构即不是新增功能也不是修改bug的代码变动test添加或修改测试build构建过程或辅助工具的变动
补充
chore: 构建工具、辅助工具或其他无关紧要的任务perf: 改进性能的代码更改revert: 撤销以前的提交
2scope
scope用于说明 commit 影响的范围比如指标模板、规则上下线等等视项目不同而不同。
3subject
subject是 commit 目的的简短描述不超过50个字符。
以动词开头使用第一人称现在时比如change而不是changed或changes第一个字母小写结尾不加句号.
1.2 Body
Body 部分是对本次 commit 的详细描述可以分成多行。
需要简要的列出各种正向或者反向的测试场景测试通过填pass。关闭的Issue(References) (可选): 如果此提交与某个问题Issue相关联可以在提交消息中引用该问题。例如Fixes #123 或 Closes #456。增加修改人信息
二、例子
2.1 feat例子
feat(规则上下线、构建、生效、仿真生效): 添加规则上下线功能 1. 规则上下线主流程引擎正常订阅fldl生成正常。 pass
2. 规则上下线传入不存在的规则编号异常提示。 pass提交人xxx2.2 fix例子
fix(模型模块): 模型测试失败1. 导入mar模型包含衍生字段。 pass
2. 导入mar模型不包含衍生字段。 pass提交人xxx2.3 关闭的Issue例子
feat(auth): add user authentication feature- Implemented user login and registration
- Added user profile page
- Fixes #123, Closes #456提交人xxx使用这种规范的好处在于它使提交消息更加一致和易于搜索。同时它还允许自动化工具从提交消息中提取信息如生成发布日志或自动化版本号管理。
插件推荐
idea可以安装代码提交规范的插件。
1、安装插件 2、提交时选择插件提交 参考
Git Commit Message规范 https://blog.csdn.net/LBWNB_Java/article/details/126776372
