Git commit message 规范,你知道吗?

113 阅读2分钟

引言

Git是目前市面上最流行的版本控制工具,没有之一,相信大家应该都有用过。当使用 Git 提交代码时,提交信息虽然可以随便写,但是为了提高提交代码的维护效率和可读性,建议遵循一定的规范。

用什么规范?

现在市面上比较流行的方案是约定式提交规范,它受到了Angular提交准则的启发,并在很大程度上以其为依据。提交格式如下:

<type>(<scope>): <subject>

<body> 

<footer>
  • <type> 必填,代表提交的类型,建议使用以下几种类型之一:

    • feat:新增功能
    • fix:修复问题
    • docs:文档变更
    • style:代码样式变更(不影响代码功能)
    • refactor:重构代码
    • test:增加或修改测试代码
    • chore:构建过程或辅助工具的变更
    • perf: 优化相关,比如提升性能、体验
    • revert: 回滚到上一个版本
  • <scope> 非必填,是提交影响的范围,用于说明哪些功能模块受到影响。

  • <subject> 必填,是一个简短的描述,用于概括提交行为的信息和目的。

    • 以动词开头,例如: 新增、修改、删减、撤销等
    • 结尾不加句号
  • <body> 非必填,是提交的详细说明,可以包含更多的上下文、解决方案、变更细节等。

  • <footer> 非必填,用于引用相关的问题、关联的文档链接等其他信息。

提交示例

feat: 添加用户验证功能 为应用程序添加了新的用户验证功能,以确保安全性和访问控制。主要实现了以下功能: 

- 用户注册和登录 
- 访问令牌生成和管理 
- 权限验证和访问控制 

该功能解决了项目需求中提到的安全性问题,并与问题跟踪系统中的问题#23关联。