Git commit message和工作流规范

简介:

总体方案

1030776-20170304152156235-891182085.png

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

如下图所示:

1030776-20170304153136563-2126734467.png

  • 第三步:将代码同步到远程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
















本文转自xsster51CTO博客,原文链接:http://blog.51cto.com/12945177/1932213 ,如需转载请自行联系原作者










相关文章
|
人工智能 前端开发 Java
用git rebase命令合并开发阶段中多条commit提交记录
通过 `git rebase`,可以合并多个提交记录,使开发历史更简洁清晰。操作分为 6 步:查看提交历史 (`git log --oneline`)、设置需合并的提交数 (`git rebase -i HEAD~N`)、修改动作标识为 `s`(squash)、保存退出编辑、调整提交信息、强制推送至远程仓库 (`git push -f`)。此方法适合清理本地无关提交,但若有团队协作或冲突风险,需谨慎使用以避免问题。
3016 60
|
存储 人工智能 缓存
Git Commit规范:为什么有些公司要求变更行数限制?·优雅草卓伊凡
Git Commit规范:为什么有些公司要求变更行数限制?·优雅草卓伊凡
665 3
Git Commit规范:为什么有些公司要求变更行数限制?·优雅草卓伊凡
|
API 开发工具 git
使用git pull遇到Automatic merge failed; fix conflicts and then commit the result.解决方案卓伊凡
使用git pull遇到Automatic merge failed; fix conflicts and then commit the result.解决方案卓伊凡
890 0
使用git pull遇到Automatic merge failed; fix conflicts and then commit the result.解决方案卓伊凡
|
开发工具 git
使用Git下载指定版本或指定commit
使用Git下载指定版本或指定commit
|
JavaScript 前端开发 持续交付
实际工作中 Git Commit 代码提交规范是什么样的?
实际工作中 Git Commit 代码提交规范是什么样的?
1416 7
|
前端开发 开发工具 git
Git报错处理:解决git commit时的lint-staged错误提示。
极好的,你对Git的lint-staged出了一个令人头疼的问题。让我们一起钻研一下,找到一种方法来解决一切。 首先,我们要确定你是在做什么操作时候遇到了问题。lint-staged通常在我们运行 git commit 时启动,它做的工作是在你提交之前运行一些指定的命令检查你的代码。当lint-staged报错,多半是因为检查未通过,或者它试图运行的命令存在问题。 让我们以一种图解的方式来描绘一下这个过程,就像canvas上的画面那样。git正在温柔的将你的修改捆绑起来,准备提交。突然,lint-staged走了出来,并开始盘问着Git,寻找可能的错误。如果lint-staged找到了什么
1374 24
|
存储 项目管理 开发工具
图解Git——分支开发工作流《Pro Git》
分支开发工作流利用Git的分支功能,支持灵活的项目管理。长期分支如`master`和`develop`分别保存稳定和开发中的代码;短期主题分支用于开发单一特性或修复问题,完成后合并到主分支。此模式确保代码稳定性,支持并行开发、便于审查和灵活调整。建议维护明确的长期分支,保持主题分支短小精悍,并定期清理无用分支。配置上可保护关键分支,遵循命名规范。
910 7
|
开发工具 C# git
C#一分钟浅谈:Git 版本控制与 GitFlow 工作流
【10月更文挑战第22天】本文介绍了 Git 和 GitFlow 的结合使用,从基础概念到具体操作,涵盖了安装配置、基本命令、GitFlow 工作流的核心分支和流程示例。同时,文章还讨论了常见的问题和易错点,如忽略文件、冲突解决、回退提交和分支命名规范,并提供了代码案例。通过学习本文,读者可以更好地理解和应用 Git 及 GitFlow,提高团队协作效率。
501 1
|
开发工具 git
一文教你如何设置git commit模板规范
一文教你如何设置git commit模板规范