美文网首页
最简Git提交规范

最简Git提交规范

作者: 小白兔胡萝卜 | 来源:发表于2023-08-28 18:58 被阅读0次

Git 代码规范

Git 每次提交代码,都是需要写Commit message(提交说明)。一般Commit message 的格式包含三个部分:

Header -----必填

    type ---必需

    scope --- 可选

    subject ---必需

Body ---- 可省略

Footer ---- 可省略

提交遵循原子性提交原则:每次尽可能最小量提交,仅包含一个不可分割的基本特性、问题修复或者优化提升,以便于code review / rollback / modification

在实际提交实践的过程中,大部分时候仅包含了Herder,提交最简、最重要的消息,即 :

Header = 【Type】+【Subject】


Type

feat:提交新功能

fix:修复了bug

docs:只修改了文档

style:调整代码格式,未修改代码逻辑(比如修改空格、格式化、缺少分号等)

refactor:代码重构,既没修复bug也没有添加新功能

perf:性能优化,提高性能的代码更改

test:添加或修改代码测试

chore:对构建流程或辅助工具和依赖库(如文档生成等)的更改

Subject

标题是对变更的简明描述,三个注意点:

    使用祈使句,现在时态

    不要大写首字母

    结尾不要使用句号

Example

chore: add Oyster build script

docs: explain hat wobble

feat: add beta sequence

fix: remove broken confirmation message

refactor: share logic between 4d3d3d3 and flarhgunnstow

style: convert tabs to spaces

test: ensure Tayne retains clothing


Other

Body 正文是对标题的补充,不是必须的,其包含更详细的信息,如代码修改的动机、方式、与修改前的代码对比等等。

Footer 注脚,通常是BREAKING CHANGE 或修复bug的链接。

相关文章

  • iOS 小谈一叙

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

  • 我的git学习日志

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

  • Git的分支命名

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

  • git提交规范(简版)

    feat:新功能或功能变更相关fix:修复 bug 相关docs:改动了文档,注释相关style:修改了代码格式化...

  • gitflow 规范及工具整理

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

  • Java开发必备 Git 分支开发:规范指南及完全学会Git的2

    Git 是目前最流行的源代码管理工具。为规范开发,保持代码提交记录以及 git 分支结构清晰,方便后续维护,现规范...

  • git分支命名规范

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

  • git commit 提交规范(优化)

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

  • Android Studio插件--Git Commit Tem

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

  • Git 分支命名规范

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

网友评论

      本文标题:最简Git提交规范

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