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

2022-12-18  本文已影响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>

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个字符。

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

上一篇 下一篇

猜你喜欢

热点阅读