第三节 项目commit规范

2023-12-28 18:49:53

系列文章目录


目录

系列文章目录

前言

实现方法

总结


前言

多人开发项目时,每次Git提交都不明确提交了什么,增加功能?修复bug?修改了代码格式?没有哦规则。那我们制定制定提交类型及如何写提交信息的规则,提交强制必须遵守~?


操作方法

制定规范提交类型准则

说明
feat

新功能

fix:

修复一个bug

docs:

文档变更

style:

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

conflict:

修复代码冲突

font:

字体文件更新

refactor:

重构(既不是增加feature,也不是修复bug)

perf:

性能优化

test:

增加测试

chore:

构建过程或辅助工具或配置工具修改

revert:

回退

build:

影响构建系统或外部依赖项的更改(如:webpack、npm)

1、安装commitizen和cz-customizable

npm? i -g?commitizen@4.2.4

npm? i ?cz-customizable@6.3.0 --save-dev

2、在package.json中进行新增

"config": {
    "commitizen": {
      "path": "node_modules/cz-customizable"
    }
  },

3、在根目录下新建?.cz-config.js并写入配置

4、使用husky进行强制git代码提交规范

npm install husky@7.0.1 --save-dev

npm husky install

5、在package.json中新增指令并执行

?执行 npm run prepare

6、新增husky配置文件 并写入配置内容

npx husky add .husky/commit-msg

npx --no-install commitlint --edit


总结


每天记录一点,助力成长!

欢迎大家来浏览我的博客,如发现我有写错的地方,欢迎交流指正。

如果你觉得本文对你有帮助,欢迎点赞收藏转载,烦请注明出处,谢谢!

欢迎关注 点赞 留言 支持!感激不尽~?

文章来源:https://blog.csdn.net/hongc93/article/details/135249778
本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。