git使用规范 - passiony/gillar_wiki GitHub Wiki

Git 使用规范

1.规范分支使用

  • 1.master分支是产品分支,不要在master直接开发

  • 2.开发统一基于develop分支,并且使用git-flow工作流进行开发

  • 3.每个人开发自己的功能,需从develop检出新分支,开发完毕再合并到主分支,不要一条记录合并一次,或者直接在develop上开发

  • 4.新分支名称需遵循命名规范

    • feature: 格式遵守feat-issueID-moduleName, 例如feature-4213-sns
    • bug: 格式遵守fix-issueID-moduleName, 例如fix-4216-user
    • docs: 格式遵守docs-document-description, 例如docs-deploy-process
    • refactor: 格式遵守refactor-moduleName-description, 例如refactor-user-rpc
    • chore: 格式遵守chore-build-task, 例如chore-grunt-csssprite
    • test: 格式遵守test-moduleName-description, 例如test-bigdata-merge-users

2.git commit message日志,必须添加head标记,且只允许使用下面7个标识。

  • feat:新功能(feature)
  • fix:修补bug
  • docs:文档(documentation)
  • style: 格式(不影响代码运行的变动)
  • refactor:重构(即不是新增功能,也不是修改bug的代码变动)
  • test:增加测试
  • chore:构建过程或辅助工具的变动

3.git commit 提交日志的issue编号

如果新功能和修复在issue,jira或者禅道上有对应的编号。那么日志中要带有issue的编号,

格式如下:

  • fix# 0856 修复XXXbug

  • feature# 3567 完成XXX功能

⚠️ **GitHub.com Fallback** ⚠️