抱歉,您的浏览器无法访问本站
本页面需要浏览器支持(启用)JavaScript
了解详情 >

引言

当一个团队或个人使用Git作为版本控制系统时,编写规范的commit信息是非常重要的,因为它可以提高代码可读性,便于其他开发者对代码变更进行追踪和管理。然而,对于大型项目或需要频繁提交代码的开发人员来说,编写规范的commit信息可能会变得繁琐且耗费时间。

为了解决这个问题,可以使用ChatBot-Commit工具来自动生成规范的commit信息。该工具可以根据git diff命令输出的版本比较结果,自动化生成简洁明了的commit信息,从而节约程序员大量的时间和精力。此外,ChatBot-Commit工具还可以帮助规范化提交信息的格式和内容,从而提高代码质量和可维护性。
博客ChatBot示例GIF

使用方法

仓库单独使用

  1. pre-commit 文件复制到你的Git仓库的 .git/hooks 目录下。

  2. 在提交更改时,使用 git commit -m "任意文本" 命令进行提交,脚本将替换-m内容且提供一个简短的描述更改的消息。Hook 将使用 ChatGPT 生成的消息。

全局使用

  1. 创建一个新的hooks目录,用于存放所有全局hooks脚本
  2. 将hook脚本添加到该目录中
  3. 将hooks目录路径添加到Git的core.hooksPath配置选项中:

    git config --global core.hooksPath 您的目录
    
  4. 如果您想停用全局hooks,可以将core.hooksPath配置选项设置为空

    git config --global core.hooksPath ""
    

> 由于脚本修改了日志输出格式,所以大部分ide会认为是提交错误,请忽略.欢迎提供解决方案.

API

请自行搭建云函数,并将<这里替换为自己的云函数>修改为自己的云函数地址。

云函数

项目中使用的云函数是基于aircode,点击这里搭建,请修改Environments->OPENAI_KEY.git仓库chatcommit云函数key

GitHub仓库

ChatBot-Commit

许可

该项目基于 MIT 许可证。有关详细信息,请参阅 LICENSE 文件。

评论