再不用手写Commit!AI自动总结代码变更,Git提交效率

背景

今天写完代码后, commit到git仓库, 让我写提交信息时, 突然发现了些问题

1、发现git commit 经常很难描述清晰

在写后面的message, 如:

git commit -m "增加了菜单, 修复了跳转bug等"

只是很简单的概括性描述, 发现, 如果修改代码太多, 那么 -m 后面的信息经常写的不全, 修改内容描述不清.

2、发现项目里很多git commit message 都混乱

用git log 看了下, 大量描述通常如: "fix bug" 、"修复bug"、"增加字段", 之类, 具经常就是简单几个字描述. 一看就让人头痛, 不知道具体改了什么,

这种混乱的提交信息, 对后续要寻找修改历史时也带来了负担, 基于这些, 是否能用AI帮我总结这块内容呢, 于是有了下面这个项目, 先给大家直接展示效果.


展示

a、提交内容

这里用了个用户的例子展示, 开放个新接口给外部系统查询, 如: 写了个接口,大概内容如下:

b. 用GIT提交

安装完脚本后, 开始测试

复制代码
git add .  //变更加入暂存区

然后直接执行

复制代码
git commit  //提交, 注意: 没带任何说明参数  

注意这里没执行 -m 参数, AI自动给我总结了我今天的内容, 并提交成功

截图看下:

AI 帮我总结完成了, 并提交了整个修改的总结. 可以查看下

复制代码
git log  // 查看提交日志进行确认

如下:

完美!

已经自动完成对变更对总结, 并填充到了git commit message里面.

下面把小工具开源出来, 大家可以试试.


安装使用

项目地址:

上传到了github上面, 可以直接下载

https://github.com/bensonHe/auto-git-commit-message

具体如:

a. 把项目下下来

复制代码
git clone [email protected]:bensonHe/auto-git-commit-message.git

b. 准备好token

去阿里云百炼大模型, 注册个API Key (目前免费, 我一直用这个, 免费送了很多token, 感谢阿里云)

打开百炼控制台, https://bailian.console.aliyun.com/

比如我的:

c. 直接安装

直接运行项目里面的 ./install.sh

最后, 启动

ok 完美, 不用再写任何的git 的备注内容了, 清晰可见.

更多, 如果有疑问可以去看下README.MD , 这个小工具我会持续维护下, 打磨好, 难免有个别bug.

感谢包容🙏


最后

作为一名16年的老程序员, 我始终对新技术保持好奇和热情, 会继续用实战案例,和大家一起摸索如何让AI真正落地到日常开发中。如果你也感兴趣,欢迎关注我, 一起实践、一起进化