使用commitizen规范化git提交信息

前言

如果你足够细心观察的化,你会发现哪些大型项目他们的git comment信息是有规律,且非常规范的

例如 Vue 项目仓库
他们都是经过规定的格式以及类型和一些规范进行提交的
Vue Repo

那么这真的是认为一个一个的编写吗?
答: 当然不是,每一个项目都有不同的格式、类型、规范标准,如果是中小型项目可以直接使用普通默认的标准,但大型项目他们都会自定义一些标准供团队所有人去遵循,显然它是需要一款工具来进行管理这些标准的

commitizen

配合 commitlint 可以参考这篇文章: 使用 commitlint 来检查提交的信息是否符合规范

commitizen 是一个 cli 工具,它可以用于规范化 git commit 信息,可以代替 git commit 命令

安装

COPY
1
2
3
4
# 全局安装
npm install -g commitizen cz-conventional-changelog
# 然后在系统根目录创建一个配置文件
echo '{ "path": "cz-conventional-changelog" }' > ~/.czrc

用法: 你可以使用git czcz来代替git commit,你也可以使用git-cz,它是cz的别名(一般直接使用 git cz 就可以了)

当你使用git cz时系统会提示你填写必填的字段,并且你的提交消息将根据项目维护者定义的标准进行格式化
Git cz

使用

接下来就是将传统的git add .—>git commit -m"xxx"—>git push替换为git add .—>git cz—>git push就可以了,根据提示填写相关commit标准即可(会用翻译吧?会自己查阅文档和看仓库 README 吧?)

如果使用的是本地安装 git add .—>npx cz—>git push

以上基本上已经足够使用了,若想更深入的了解和自定义使用,可以自己查看文档

我觉得不因该写的特别细,能够满足基本的使用条件即可,只需要了解了使用方法后,需要自己实践、摸索、思考。这样才能把知识牢记于心,这才是真正的学会了

Authorship: Lete乐特
Article Link: https://blog.imlete.cn/article/Normalizing-git-commit-messages.html
Copyright: All posts on this blog are licensed under the CC BY-NC-SA 4.0 license unless otherwise stated. Please cite Lete乐特 's Blog !