📜  提交消息模板 (1)

📅  最后修改于: 2023-12-03 14:54:43.735000             🧑  作者: Mango

主题:提交消息模板

介绍:

提交消息模板是一个优秀的编程规范,它规定了代码提交时必须遵循的格式和内容,方便代码的维护和追踪。本文将详细介绍如何使用提交消息模板,包括常见格式和使用示例。

常见格式:

提交消息模板的常见格式如下:

<type>[optional scope]: <description>

[optional body]

[optional footer(s)]

其中,type表示提交的类型,包括feat、fix、docs、style、refactor、test、chore等,分别表示功能添加,错误修复,文档更新,格式修改,重构代码,测试代码,杂项修改等;

scope表示提交的范围,可以省略;

description是提交的简要描述,长度应该限制在50个字符以内;

body可以详细描述代码的修改,可以省略;

footer可以添加一些关闭Issues和相关信息等,可以省略。

使用示例:

一个使用提交消息模板的实例:

feat(login): add forget password feature

Add forget password feature to login page, user can retrieve password by email.

close #1234

该提交消息表示在登录页面增加了忘记密码功能,用户可以通过邮箱找回密码,并关闭了编号为1234的Issues。

返回的markdown格式:

## 提交消息模板

提交消息模板是一个优秀的编程规范,它规定了代码提交时必须遵循的格式和内容,方便代码的维护和追踪。本文将详细介绍如何使用提交消息模板,包括常见格式和使用示例。

### 常见格式

提交消息模板的常见格式如下:

[optional scope]:

[optional body]

[optional footer(s)]


其中,type表示提交的类型,包括feat、fix、docs、style、refactor、test、chore等,分别表示功能添加,错误修复,文档更新,格式修改,重构代码,测试代码,杂项修改等;scope表示提交的范围,可以省略;description是提交的简要描述,长度应该限制在50个字符以内;body可以详细描述代码的修改,可以省略;footer可以添加一些关闭Issues和相关信息等,可以省略。

### 使用示例

一个使用提交消息模板的实例:

feat(login): add forget password feature

Add forget password feature to login page, user can retrieve password by email.

close #1234


该提交消息表示在登录页面增加了忘记密码功能,用户可以通过邮箱找回密码,并关闭了编号为1234的Issues。