git提交规范示例

git规范

1、提交注释的格式

格式:(type): (subject)

注释包括2部分:类型(type)和主题(subject)。类型表示提交的种类,主题简要描述提交修改的内容。

例如:feat: 添加用户登录模块。

2、type类型

type类型可以根据具体情况进行适当的增删改,下面是一些常用的type类型:

(1)feat:新功能(feature)。

(2)fix:修复bug。

(3)docs:文档(documentation)修改。

(4)style:格式(不影响代码运行的变动)。

(5)refactor:重构(即不是新增功能,也不是修改bug的代码变动)。

(6)perf:优化相关,比如提升性能、体验。

(7)test:增加测试。

(8)chore:构建过程或辅助工具的变动。

3、subject主题

subject主题是提交注释的核心部分,它应尽量简单、清晰、易于理解。以下是几个subject的示例:

(1)feat: 添加用户登录模块。

(2)fix: 修复用户注销失败的问题。

(3)docs: 更新用户手册。

4、正文

注释正文可以更详细地说明代码修改细节和原因,如果有需要可以单独占用一行注释。
正文应该在注释首行下空一行,以增加可读性。

5、示例代码

// commit f0b9a2e
feat: 添加了忘记密码功能

为用户提供重置密码的选项,以便于在忘记密码时可以通过邮箱的方式来进行重置操作。

- 添加忘记密码的路由
- 添加忘记密码页面的模板和样式
- 实现了发送邮件功能,并同步将信息存入数据库