你不得不掌握的前端提交规范（git cz）

背景

最近在提交代码的时候发现每次提交的代码说明都是层次不齐的，看上去让人感觉到特别的凌乱。第一：让人看上去感觉这个程序猿好像不是“正规”出身，再一让自己在回溯代码的时候没有任何头绪。

简介

所以就找到了一款适合大众而且也是相当知名的代码提交规范：commitizen（git cz），这款工具也是最早 Angular 团队提交代码的时候用的一套规范，在现今 github 和团队场景中运用十分广泛的工具。

说明

commitizen 也可以简写为：git cz 格式化工具，为我们提供规范了代码的提交信息，在团队中使用能统一提交信息，在往后的代码回溯或者日志生成能够快速的查找到对应的目录。

安装

npm 安装 commitizen

npm install commitizen

yarn 安装 commitizen、

yarn add commitizen

配置命令

等待安装完之后在对应的项目下的 package.json 文件夹下添加如下命令：

"config": {"commitizen": {"path": "./node_modules/cz-conventional-changelog"}
}

添加完在控制面板中输入 git cz 命令就会出现对应的 commitizen 提交规范步骤如下图：

git cz
? Select the type of change that you're committing: (Use arrow keys)
❯ feat:     A new feature fix:      A bug fix docs:     Documentation only changes style:    Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc) refactor: A code change that neither fixes a bug nor adds a feature perf:     A code change that improves performance test:     Adding missing tests or correcting existing tests

刚开始看不懂，没关系，下面有翻译的版本。但是我并不推荐你安装汉化版的，要尝试看英文文档养成良好的习惯


feat: A new feature
壮举：新功能fix: A bug fix
修复：错误修复docs: Documentation only changes
docs：仅文档更改style: Changes that do not affect the meaning of the
样式：不影响代码含义的更改（空格、格式、缺少分号等refactor: A code change that neither fixes a bug nor
重构：既不修复错误也不添加功能的代码更改perf: A code change that improves performance
perf：提高性能的代码更改test: Adding missing tests or correcting existing tests
测试：添加缺失的测试或纠正现有的测试build: Changes that affect the build system or external dependencies
build：影响构建系统或外部依赖项的更改ci: Changes to our CI configuration files and scripts
ci：对我们的 CI 配置文件和脚本的更改chore: Other changes that dont modify src or test
杂项：不修改 src 或测试文件的其他更改revert: Reverts a previous commit
还原：还原以前的提交

以上基本上就是对照的中文说明。前期可以多尝试看看，后期再提交的时候自然而然就熟悉提交的说明了。

如果你修改了bug，那么第一步就是选择 fix选项：fix
第二步会出现一个 Specify a scope：意思就是这次修改的文件夹是那部分，我一般选择 src/home/banner…等等，这些文件夹可以选择更改的目录
第三步会出现write a short description：意思是写一段简短的描述。我一般会：修改了…bug等
其余选项可以直接敲回车就可，最后生成的commitizen 信息就是：fix(src/home/banner): 修改了…bug。是不是看上去很清晰！

好了，今天这一篇就是介绍前端工程化的一些规范工具，有什么问题欢迎随时留言~

你不得不掌握的前端提交规范（git cz）相关推荐

一个维护版本日志整洁的Git提交规范
1 关于提交日志规范良好的Commit Message有利于代码审查,能更快速查找变更记录,并且可以直接生成Change log. Commit Message的写法规范:conventional- ...
从0到1开发实战手机站（二）：Git提交规范配置
生活不能随意过,代码也不能随意写. 前一篇文章我们已经把项目搭建好了,那是不是马上就开始写页面了呀? NO! 无论在哪家公司,都会有相应的代码规范.新入职的员工往往第一步就要接受代码规范的学习. 既然 ...
git提交规范图-提问的智慧图谱-React 学习路线图- 达克效应
##git提交规范 git commit的提交规范 ##提问的智慧图谱好句 <span style="color:yellow"">一个成功的团队要有三种人 ...
Git解决方案之提交规范
Git 的提交规范 1 概述格式: <type>(<scope>): <subject><body><footer> 上述大概分为3部分( ...
Git基础：第七、八章 Git提交规范Github/Gitee(github资料附录表)
文章目录第七章 Git提交规范 7.1 Commit Message 7.1.1 自动化校验commit message 7.2 Author & Committer 7.3 Changed ...
【git】(task4)git提交规范和github说明
学习总结学习datawhale的git教程.Pull Requests:PR,是github中将修改过的代码分支合并到目标分支的操作.commit是git的最小工作单元,在github的仓库中,PR ...
git规范化提交 git cz
1 安装git cz指令 git指令提交代码的时候,可以通过git cz指令来让提交更规范一些,比如写上提交的代码写了哪些功能.修改了哪些文件等等信息,也可以方便自己日后查看安装指令: npm in ...
别乱提交代码了，看下大厂 Git 提交规范是怎么做的！
Git是现在市面上最流行的版本控制工具,书写良好的commit message能大大提高代码维护的效率. 但是在日常开发中由于缺少对commit message的约束,导致填写内容随意.质量参差不齐, ...
git提交后的代码在哪儿_别乱提交代码了，来围观下大厂的 Git 提交规范
点击上方"Python编程时光",选择"加为星标"第一时间关注Python技术干货! 作者:人人贷大前端技术中心链接:https://juejin.im/po ...

你不得不掌握的前端提交规范（git cz）

背景

简介

说明

安装

配置命令

你不得不掌握的前端提交规范（git cz）相关推荐

最新文章

热门文章