代码提交msg模板配置

vi ~/.gitconfig

若不存在[commit] template,则设置如下

[commit]
        template = ~/.CommitMsg

.gitconfig内容

vi ~/.CommitMsg

粘贴以下内容

<fix> <kernel>: update year in licence

[JIRA-24]模块异常

修复由于空指针问题导致的kernel模块异常,去除未定义函数

格式说明:

type 必填字段 提交类型。只允许从如下几种类型中选择

feat 新特性 fix: 修改问题bug int: 集成第三方二进制文件

docs: 文档修改 refactor: 代码重构 style:代码格式修改,代码美化,不影响具体功能逻辑

test: 测试用例修改 chore:其他修改,比如构建流程,辅助工具,依赖管理

scope 必填字段 影响范围:描述该提交是针对哪个功能。若是集成第三方变更,则填第三方名称

subject必填字段主题:简短描述该提交的目的要求:小写,以功能feature(参考FIP)为单位。不是以子系统为单位,也不是以软件组件名(包名,库名)为单位
要求:第一人称现在时,动词开头,小写开头,英语 50 字符以内,结尾无句号

L2 BLANK LNE 必填字段 空行。这里必须留空行,否则Gerrit上面会把L1和L3连在一块显示,导致显示混乱

L3 [work id]: #xxXX 选填字段 工作编号:该提交关联的工作编号。如任务管理系统或者Bug管理系统(如Jira)上的Bug或者Task ID
xXXX为具体的工作编号。如需关联多个编号,可用逗号分隔。如:[work id]:#12345.#67890

L4 BLANK UNE 必填字段 空行。为美观起见,建议留空行

L5~n details 必填字段 详细说明:详细描述该提交的内容。
需要说明该提交改了什么,为什么这宏改如果是修复了某个Bug,需要描述Root Cause和Solution。Root Cause需要能够回答至少3个为什么。

如果是新增或者移除了某个feature,需要描述需求来源和概要实现方案
如果是集成了第三方的发布,则根据其release note,描述新增了什么feature或修复了什么Bug。

猜你喜欢

转载自blog.csdn.net/qq_27577263/article/details/121222079