美文网首页
GIt commit 规范

GIt commit 规范

作者: 失眠是真滴难受 | 来源:发表于2020-10-04 15:23 被阅读0次

最近有幸参与到了一个开源项目的活动,看到别人提交的 commit 都很规范,自己的都是些什么鬼?经过一番搜索,发现网上很多都提到了 angularjs 的规范

** 格式 **

Commit Message 格式

<type>(<scope>): <subject>
<空行>
<body>
<空行>
<footer>

分为 页眉、正文和页脚。其中页眉包括了类型、范围还有 subject。

type

类型 描述
feat 新增 feature
fix 修复bug
docs 仅仅修改了文档,比如 README...
style 修改了空格、格式缩进、逗号等,不改变代码逻辑
refactor 代码重构,没有加新功能或者修复bug
perf 优化相关,比如提升性能、体验
test 测试用例,比如单元测试、集成测试等
chore 改变构建流程、或者增加依赖库、工具等
revert 回滚到上一个版本

scope

具体改动的文件

subject

对正文的概括

body

just as in <subject> use imperative, present tense: “change” not “changed” nor “changes”

includes motivation for the change and contrasts with previous behavior

footer

不兼容变动

如果当前代码和上一个版本不兼容,需要在这里以 BREAKING CHANGE 开头,后面接具体的描述

相关 issues

这里是和变动相关的 issues。例如:

Closed bugs should be listed on a separate line in the footer prefixed with "Closes" keyword like this:

Closes #234

or in case of multiple issues:

Closes #123, #245, #992

工具

既然有标准了,那肯定就会有对应的工具来辅助人们写 commit message,工具貌似还不少,我这里使用 git-cz

在需要使用 git commit 的时候换成 git cz 就行了。

就像这样 图片

是不是很方便?

公众号:没有梦想的阿巧 后台回复 "群聊",一起学习,一起进步

相关文章

  • 使用 git hook 规范 Android 项目

    引言 本文所说的『规范』包含两个部分 git commit 是注释的规范 git commit 时对代码规范的检查...

  • git commit规范

    git commit规范 git-commit规范 在多人协作项目中,如果代码风格统一、代码提交信息的说明准确,那...

  • gitflow 规范及工具整理

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

  • GIT 规范

    git 规范 git 规范一般包括两点:分支管理规范和 git commit 规范。 分支管理规范 一个项目可以创...

  • git操作

    git规范 Git 使用规范流程 团队中的 Git 实践 Git: 教你如何在Commit时有话可说 Git工作流...

  • Git Commit message(Angular规范)

    Git Commit message(Angular规范) Commit message 的格式 1. Heade...

  • git commit 提交规范(优化)

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

  • 用 git 钩子,检测代码规范性(eslint、standard

    最终实现效果说明: 用 git commit 提交代码之前,利用 pre-commit git 钩子,实现代码规范...

  • git提交规范

    git的规范和相关科普知识 git commit 的规范要求(参考Angular团队) message格式如下: ...

  • 我的git学习日志

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

网友评论

      本文标题:GIt commit 规范

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