Git commit message和工作流规范

总体方案

Git commit日志基本规范

<type>(<scope>): <subject><BLANK LINE><body><BLANK LINE><footer>

对格式的说明如下：

type代表某次提交的类型，比如是修复一个bug还是增加一个新的feature。所有的type类型如下：
feat：新增feature
fix: 修复bug
docs: 仅仅修改了文档，比如README, CHANGELOG, CONTRIBUTE等等
style: 仅仅修改了空格、格式缩进、都好等等，不改变代码逻辑
refactor: 代码重构，没有加新功能或者修复bug
perf: 优化相关，比如提升性能、体验
test: 测试用例，包括单元测试、集成测试等
chore: 改变构建流程、或者增加依赖库、工具等
revert: 回滚到上一个版本

格式要求：

# 标题行：50个字符以内，描述主要变更内容## 主体内容：更详细的说明文本，建议72个字符以内。 需要描述的信息包括:## * 为什么这个变更是必须的? 它可能是用来修复一个bug，增加一个feature，提升性能、可靠性、稳定性等等# * 他如何解决这个问题? 具体描述解决问题的步骤# * 是否存在副作用、风险? ## 尾部：如果需要的化可以添加一个链接到issue地址或者其它文档，或者关闭某个issue。

Git分支与版本发布规范

基本原则：master为保护分支，不直接在master上进行代码修改和提交。
开发日常需求或者项目时，从master分支上checkout一个feature分支进行开发或者bugfix分支进行bug修复，功能测试完毕并且项目发布上线后，将feature分支合并到主干master，并且打Tag发布，最后删除开发分支。分支命名规范：
- 分支版本命名规则：分支类型 _ 分支发布时间 _ 分支功能。比如：feature_20170401_fairy_flower
- 分支类型包括：feature、 bugfix、refactor三种类型，即新功能开发、bug修复和代码重构
- 时间使用年月日进行命名，不足2位补0
- 分支功能命名使用snake case命名法，即下划线命名。
Tag包括3位版本，前缀使用v。比如v1.2.31。Tag命名规范：
- v2.0.0-alpha-1
- v2.0.0-belta-1
- 新功能开发使用第2位版本号，bug修复使用第3位版本号
- 核心基础库或者Node中间价可以在大版本发布请使用灰度版本号，在版本后面加上后缀，用中划线分隔。alpha或者belta后面加上次数，即第几次alpha：
版本正式发布前需要生成changelog文档，然后再发布上线。

如何接入？

接入参考commit-message-test-project项目。具体步骤如下：

第一步：在工程跟目录下的package.json文件加入如下代码所示的scripts和dependencies内容，版本号为3位版本号。

  {"name": "application-name",    "version": "0.1.0",    "scripts": {"commitmsg": "validate-commit-msg",      "commit": "git-cz ",      "changelog": "conventional-changelog -p angular -i CHANGELOG.md -s -r 0"},    "devDependencies": {"commitizen": "^2.3.0",      "validate-commit-msg": "^2.11.1",      "conventional-changelog-cli": "^1.2.0",      "husky": "^0.13.1"}}

第二步：在工程根目录新建.vcmrc文件，并且文件内容为

{"helpMessage": "\nPlease fix your commit message (and consider using https://www.npmjs.com/package/commitizen)\n",  "types": ["feat",    "fix",    "docs",    "style",    "refactor",    "perf",    "test",    "chore",    "revert"],  "warnOnFail": false,  "autoFix": false}

接入后的Git commit操作流程

第一步：创建一个feature分支或者bugfix分支
sh $ git checkout -b feature_infinite_load # 切换到一个feature分支或者bug fix分支 sh

第二步：将代码提交到本地Git仓库，并填写符合要求的Commit message格式

  $ git add .                                $ git commit                               # 此处不要加任何参数，比如-m

如下图所示：

第三步：将代码同步到远程Git仓库

  $ git push origin feature_infinite_load    # 将修改发布到远程仓库

第四步：自动生成changelog，并打Tag发布

  $ tnpm run changelog                    # 使用npm script中的changlog命令直接从git元数据生成日志。$ git tag v0.1.0$ git push origin v0.1.0

转载于:https://blog.51cto.com/12945177/1932213

Git commit message和工作流规范相关推荐

Git学习总结（23）——Git commit message和版本管理规范总结
一.Git commit message基本规范对格式的说明如下: type代表某次提交的类型,比如是修复一个bug还是增加一个新的feature.所有的type类型如下: feat: 新增feat ...
Git Commit Message校验踩坑指南
背景在团队多人开发中,规范的commit message可以快速定位代码提交历史,回溯问题根源,方便组内多人协作,提高团队效率. 本篇文章主要包含以下两方面内容: commitizen/cz-cli ...
git commit message——git提交日志规范备忘
使用git提交时,最好能注意保持规范,可能某些公司对这方面没有要求,但是提交日志不规范的话,不方便查阅和管理. 在此记录下commit的类别,备忘,更详细的介绍,可以查看文末链接. commit me ...
commitizen和cz-customizable配置git commit message 1
起因团队对提交的commit message格式有约定俗称的要求,但是没有一个统一的规范,导致大家提交的commit message或多或少不太一样.因此,需要一个工具来帮助大家统一commit m ...
如何规范你的Git commit？
简介:commit message应该如何写才更清晰明了?团队开发中有没有遇到过让人头疼的git commit?本文分享在git commit规范建设上的实践,规定了commit message的格式 ...
Git commit hook 规范标准配置
Git每次提交代码都需要写commit message,否则就不允许提交.一般来说,commit message应该清晰明了,说明本次提交的目的,具体做了什么操作--但是在日常开发中,大家的commi ...
git commit 规范指南
前言 Git 每次提交代码,都要写 Commit message(提交说明),否则就不允许提交.但是,一般来说,commit message 应该清晰明了,说明本次提交的目的. 不过话说回来,作为最具 ...
Git 提交的正确姿势：Commit message 编写指南
Git 每次提交代码,都要写 Commit message(提交说明),否则就不允许提交. $ git commit -m "hello world" 上面代码的-m参数,就是用来 ...
git commit规范、CHANGELOG生成和版本发布的标准自动化
长期以来,大家是不是受限于这种情况:团队中每位成员提交代码时填写的信息随意,没有一定的规范,在出问题后想要定位到某次提交记录时更是难上加难,或者是加上了 commitlint之类的规范,也没有添加ch ...

Git commit message和工作流规范

总体方案

Git commit日志基本规范

Git分支与版本发布规范

如何接入？

接入后的Git commit操作流程

Git commit message和工作流规范相关推荐

最新文章

热门文章