如何规范你的Git commit?
共 3980字,需浏览 8分钟
· 2020-08-30
点击「阅读原文」查看良许原创精品视频。
点击「阅读原文」查看良许原创精品视频。
导读:commit message应该如何写才更清晰明了?团队开发中有没有遇到过让人头疼的git commit?本文分享在git commit规范建设上的实践,规定了commit message的格式,并通过webhook在提交时进行监控,避免不规范的代码提交。
<type>(<scope>): <subject>
fix:产生diff并自动修复此问题。适合于一次提交直接修复问题
to:只产生diff不自动修复此问题。适合于多次提交。最终修复问题提交时使用fix
建议使用中文(感觉中国人用中文描述问题能更清楚一些)。
结尾不加句号或其他标点符号。
fix(DAO):用户查询缺少username属性
feat(Controller):用户查询接口开发
便于程序员对提交历史进行追溯,了解发生了什么情况。
一旦约束了commit message,意味着我们将慎重的进行每一次提交,不能再一股脑的把各种各样的改动都放在一个git commit里面,这样一来整个代码改动的历史也将更加清晰。
格式化的commit message才可以用于自动化输出Change log。
服务注册:服务注册主要完成代码库相关信息的添加。
重复校验:防止merge request再走一遍验证流程。
消息告警:对不符合规范以及大代码量提交、删除文件等操作发送告警消息。
DB:存项目信息和git commit信息便于后续统计commit message规范率。
推荐阅读:
5T技术资源大放送!包括但不限于:C/C++,Linux,Python,Java,PHP,人工智能,单片机,树莓派,等等。在公众号内回复「1024」,即可免费获取!!