Skip to content

Latest commit

 

History

History
75 lines (75 loc) · 3.38 KB

Git协作规范.md

File metadata and controls

75 lines (75 loc) · 3.38 KB

Git团队协作开发规范文档

1. 规范来源

本文档使用前端框架Angular的仓库提交规范。

2. 规范目的

  • 为了更好的管理项目,提高项目的可维护性。
  • 为了方便项目的迭代和版本管理。
  • 为了更好的管理团队成员的工作。
  • 为了保证代码的书写质量。

3. 规范内容

3.1 分支管理

  • master分支:主分支,用于发布正式版本,只能从develop分支合并。
  • develop分支:开发分支,用于日常开发,只能从feature分支合并。

3.2 提交规范

  • 提交信息的格式:<type>(<scope>): <subject>
  • 提交信息的类型:featfixdocsstylerefactortestchorerevert
  • 提交信息的范围:<scope>用于说明提交的影响范围,比如<scope>可以是componentdirectiveservicemodelviewcontrollermodulerouteconfigdirectivefiltertemplatestylebuildcidocsperfrefactortesttoolvendor等。
  • 提交信息的主题:<subject>是提交信息的简短描述,不超过50个字符。
  • 提交信息的主体:<body>是提交信息的详细描述,可以分为多行,每行不超过72个字符。
  • 提交信息的结尾:<footer>是提交信息的结尾,可以分为多行,每行不超过72个字符。

3.3 提交示例

# feat: 新增了一个功能
# fix: 修复了一个bug
# docs: 修改了文档
# style: 修改了代码格式
# refactor: 重构了代码
# test: 增加了测试
# chore: 修改了构建流程、或者增删了依赖库、工具等
# revert: 撤销了上一次的提交
# feat(component): 新增了一个组件
# fix(directive): 修复了一个指令
# docs(service): 修改了服务的文档
# style(model): 修改了模型的代码格式
# refactor(view): 重构了视图
# test(controller): 增加了控制器的测试
# chore(module): 修改了模块的构建流程
# revert(route): 撤销了路由的上一次的提交
# feat(component): 新增了一个组件

3.4 必要说明

<type>(<scope>): <subject>
# 空一行
<body>
# 空一行
<footer>
  • <type><subject>是必需的,<body><footer>是可选的。
  • 一般情况下我们只需要写<type><scope><subject>
  • 如果<type>featfixdocsstylerefactortestchorerevert中的任意一个,那么<scope>是必需的。
  • [强制]每次提交必须有typesubject,非docsstyle其余类型必须包含scope

3.5 提交示例

示例:新增了一个邮件工具类

feat(utils): 新增了一个邮件工具类

or

feat(tool): 新增了一个邮件工具类

or

feat(工具类): 新增了一个邮件工具类

示例:整理了一下代码格式

style: 整理了一下代码格式

注:style类型不需要scope

3.6 提交注意

  1. 在每次提交之前,先从develop分支拉取最新代码,然后再合并到develop分支。
  2. 如果是改动之前的提交,一定要立即提交,不要等到一次性提交,且提交需要标识revert
  3. 如果是新增功能,一定要先提交到develop分支,然后再合并到master分支。
  4. 核心功能的提交,一定要写明typescope,非核心功能的提交,一定要写明type
  5. 多提交、多合并、多拉取,保证代码的最新性。