使用git的一些规范

257 阅读1分钟

commit message 规范

代码风格统一,代码提交信息的说明准确,那么在后期协作以及 Bug 处理时会更加方便,先来介绍推荐采用的 commit 规范吧,Commit message 格式如下: type(scope): subject 注意冒号后面有空格,type 用于说明 commit 的类别,只允许使用下面 7 个标识:

type:type 用于说明 commit 的类别

  • feat:新功能(feature)

  • fix:修补 bug

  • docs:文档(documentation)

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

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

  • test:增加测试

  • chore:构建过程或辅助工具的变动

如果 type 为 feat 和 fix,则该 commit 将肯定出现在 Change log 之中。

scope:可选项,用于说明 commit 的影响范围

subject::commit 目的的简短描述,不超过 50 个字符,且结尾不加句号

Git 分支的规范

  • master 分支为主分支 (保护分支),不能直接在 master 上进行修改代码和提交;
  • develop 分支为测试分支,所以开发完成需要提交测试的功能合并到该分支;
  • feature 分支为开发分支,大家根据不同需求创建独立的功能分支,开发完成后合并到 develop 分支;
  • fix 分支为 bug 修复分支,需要根据实际情况对已发布的版本进行漏洞修复;