优雅的提交你的 Git Commit Message 2020-02-21 默认分类 暂无评论 1599 次阅读 在使用版本控制软件进行开发到时候 经常会遇到需要翻看历史提交内容到情况 规范化的提交信息 能够给日后检索带来极大到方便 也是团队开发必须遵守的一种基本制度 <h2><a class="cl-offset" name="cl-1"></a> 一、Commit message 的作用 </h2> - 提供更多的历史信息，方便快速浏览。 - 过滤某些commit（比如文档改动），便于快速查找信息。 - 直接从commit生成Change log。 <h2><a class="cl-offset" name="cl-2"></a>二、Commit message 的格式 </h2> <type>(<scope>): <subject> // 空一行 [body] // 空一行 <footer> (1) type 用于说明 commit 的类别，只允许使用下面的几种标识。 feat : 新功能 fix : 修复bug docs : 文档改变 style : 代码格式改变 refactor : 某个已有功能重构 perf : 性能优化 test : 增加测试 build : 改变了build工具 如 grunt换成了 npm revert : 撤销上一次的 commit chore : 构建过程或辅助工具的变动 如果type为feat和fix，则该 commit 将肯定出现在 Change log 之中。其他情况（docs、chore、style、refactor、test）由你决定，要不要放入 Change log，建议是不要。 （2）scope scope用于说明 commit 影响的范围，比如数据层、控制层、视图层等等，视项目不同而不同。 （3）subject subject是 commit 目的的简短描述，不超过50个字符。 <h2><a class="cl-offset" name="cl-3"></a>三、Commitizen: 替代你的 git commit </h2> Commitizen是一个撰写合格 Commit message 的工具。 安装命令如下。 $ npm install -g commitizen 然后，在项目目录里，运行下面的命令，使其支持 Angular 的 Commit message 格式。 $ commitizen init cz-conventional-changelog --save --save-exact 以后，凡是用到git commit命令，一律改为使用git cz。 这时，就会出现选项，用来生成符合格式的 Commit message。 <h2><a class="cl-offset" name="cl-4"></a>四、validate-commit-msg </h2> validate-commit-msg 用于检查 Node 项目的 Commit message 是否符合格式。 它的安装是手动的。首先，拷贝下面这个JS文件，放入你的代码库。 文件名可以取为validate-commit-msg.js。 接着，把这个脚本加入 Git 的 hook。 下面是在package.json里面使用 ghooks，把这个脚本加为commit-msg时运行。 "config": { "ghooks": { "commit-msg": "./validate-commit-msg.js" } } 然后，每次git commit的时候，这个脚本就会自动检查 Commit message 是否合格。 如果不合格，就会报错。 $ git add -A $ git commit -m "edit markdown" INVALID COMMIT MSG: does not match "<type>(<scope>): <subject>" ! was: edit markdown <h2><a class="cl-offset" name="cl-5"></a>五、生成 Change log </h2> 如果你的所有 Commit 都符合 Angular 格式，那么发布新版本时， Change log 就可以用脚本自动生成（例1，例2，例3）。 生成的文档包括以下三个部分。 New features Bug fixes Breaking changes. 每个部分都会罗列相关的 commit ，并且有指向这些 commit 的链接。当然，生成的文档允许手动修改，所以发布前，你还可以添加其他内容。 conventional-changelog 就是生成 Change log 的工具，运行下面的命令即可。 $ npm install -g conventional-changelog $ cd my-project $ conventional-changelog -p angular -i CHANGELOG.md -w 上面命令不会覆盖以前的 Change log，只会在CHANGELOG.md的头部加上自从上次发布以来的变动。 如果你想生成所有发布的 Change log，要改为运行下面的命令。 $ conventional-changelog -p angular -i CHANGELOG.md -w -r 0 为了方便使用，可以将其写入package.json的scripts字段。 { "scripts": { "changelog": "conventional-changelog -p angular -i CHANGELOG.md -w -r 0" } } 以后，直接运行下面的命令即可。 $ npm run changelog （完） <h2><a class="cl-offset" name="cl-6"></a>六、使用jetbrain的插件 </h2>   选择Type，填写相应内容，最后点击提交即可： **传送门** 插件下载 https://plugins.jetbrains.com/plugin/9861-git-commit-template/versions 文章参考自: [Commit message 和 Change log 编写指南 阮一峰](https://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html "Commit message 和 Change log 编写指南 阮一峰") 文章目录 一、Commit message 的作用 二、Commit message 的格式 三、Commitizen: 替代你的 git commit 四、validate-commit-msg 五、生成 Change log 六、使用jetbrain的插件 标签: git 转载请注明文章来源 本作品采用 知识共享署名-相同方式共享 4.0 国际许可协议 进行许可。
评论已关闭