美文网首页
git gitee github等系列提交备注规范,提交规范(实

git gitee github等系列提交备注规范,提交规范(实

作者: 学习微站 | 来源:发表于2022-12-18 21:36 被阅读0次


<新功能|bug修复|文档改动|格式化|重构|测试代码>: (影响范围) <主题> # 解释为什么要做这些改动?issue #? 一、type 类型

type 包含以下几种:【统一全部变成小写】
增加了这些
feat、feature : 新增 feature 新功能
fix: 修复 bug
docs: 仅仅修改了文档,比如 README, CHANGELOG, CONTRIBUTE等等
style: 仅仅修改了空格、格式缩进、逗号等等,不改变代码逻辑
refactor: 代码重构,没有加新功能或者修复 bug
perf: 优化相关,比如提升性能、体验
test: 测试用例,包括单元测试、集成测试等
chore: 改变构建流程、或者增加依赖库、工具等 revert: 回滚到上一个版本 撤销上一次的commit

add:新功能
update:更新
del:移除文件
build:构建工具或构建过程的变动,如:webpack升级、gulp替换为webpack等 二、description 描述

影响范围(可选) 用于说明此次提交影响到的范围,如数据层、控制层、视图层等。

主题 用于本次提交的主题简短说明,可含主要模块的相关说明。

issue(可选)

所关联的issue。

另一版本的git提交规范

首先,规范没有好坏,只有适不适合,这是种习惯,为了可读性、方便查询代码提交记录

commit message格式

<type>(<scope>): <subject>
  • 1

type(必须)

用于说明git commit的类别,只允许使用下面的标识。

feat:新功能(feature)。

fix/to:修复bug,可以是QA发现的BUG,也可以是研发自己发现的BUG。

fix:产生diff并自动修复此问题。适合于一次提交直接修复问题
to:只产生diff不自动修复此问题。适合于多次提交。最终修复问题提交时使用fix docs:文档(documentation)。

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

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

perf:优化相关,比如提升性能、体验。

test:增加测试。

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

revert:回滚到上一个版本。

merge:代码合并。

sync:同步主线或分支的Bug。

scope(可选)

scope用于说明 commit 影响的范围,比如数据层、控制层、视图层等等,视项目不同而不同。

例如在Angular,可以是location,browser,compile,compile,rootScope, ngHref,ngClick,ngView等。如果你的修改影响了不止一个scope,你可以使用*代替。

subject(必须)

subject是commit目的的简短描述,不超过50个字符。

本文使用 文章同步助手 同步

相关文章

  • 我的git学习日志

    关于提交规范(git commit conventions) 参考文献: 你可能会忽略的 Git 提交规范Comm...

  • iOS 小谈一叙

    一、规范 1) git 提交规范 适当使用git merge / git rebase 2) 代码规范 注意改动别...

  • Git的分支命名

    主要规范两点: git 分支命名规范 git提交记录规范 一. git 分支命名规范 git分支分为集成分支、功能...

  • git commit 提交规范(优化)

    git commit 提交模板和规范 Git每次提交代码,都要写 Commit message(提交说明),否则就...

  • Android Studio插件--Git Commit Tem

    规范团队代码提交,Android studio 可以使用 Git Commit Template 插件对Git提交...

  • gitflow 规范及工具整理

    gitflow 进阶规范 git cz 通过工具 git-cz 规范 git commit 提交信息。 使用 gi...

  • 版本库提交信息规范与自动验证

    版本库提交信息规范 以下规范是社区使用最广的 Angular 规范。 一般提交命令我们使用如 git commit...

  • git分支命名规范

    git 分支命名规范 git 分支命名规范 为规范开发,保持代码提交记录以及 git 分支结构清晰,方便后续维护,...

  • AndroidStudio插件-Git Commit Templ

    为了规范化团队代码提交,可以使用Git Commit Template插件对git提交规范进行一定的约束,方便后期...

  • git提交规范

    建议在提交之前加上如下5种前缀:1、[Add] 增加新功能2、[Change] 改变需求3、[Fix] 修复错误4...

网友评论

      本文标题:git gitee github等系列提交备注规范,提交规范(实

      本文链接:https://www.haomeiwen.com/subject/tpwqtdtx.html