使用 VSCode 进行 AI Commit 的笔记
1. 什么是 AI Commit?
AI Commit 是一种利用人工智能(AI)技术自动生成 Git 提交信息(Commit Message)的工具。它可以帮助开发者根据代码变更自动生成简洁、准确的提交信息,从而节省时间并提高提交信息的质量。
主要来讲,AI Commit包含两种形态,
第一种形态就是直接在git命令行里面生成,例如: https://github.com/guanguans/ai-commit/blob/main/README-zh_CN.md
第二种形态则是使用vscode或者其他编译器,通过GUI的方式进行发布,而这也是我喜欢的方式,(下面是CodeGeeX官方示例)
2. 为什么使用 AI Commit?
- 提高效率:手动编写提交信息可能耗时,尤其是当提交频繁时。
- 一致性:AI Commit 可以生成格式一致的提交信息,便于团队协作和代码审查。
- 准确性:AI 可以根据代码变更自动生成更准确的描述,减少人为错误。
3. 如何在 VSCode 中使用 AI Commit?
3.1 安装必要的插件
首先,你需要在 VSCode 中安装一个支持 AI Commit 的插件。以下是推荐的插件:
- Fitten:可免费使用
- CodeGeek 目前也是免费使用,效果还好
你可以通过 VSCode 的扩展市场搜索并安装这些插件。
3.2 配置 AI Commit 插件
安装完成后,你需要对插件进行一些基本配置:
基本上都是登录就能用
3.3 使用 AI Commit 生成提交信息
-
进行代码变更:在你的项目中进行一些代码更改。
-
打开 Git 面板:在 VSCode 的侧边栏中点击 Git 图标,或按下
Ctrl + Shift + G
打开 Git 面板。 -
暂存更改:在 Git 面板中,选择你想要提交的更改并点击
+
号暂存它们。 -
生成提交信息:在 Git 面板的提交信息输入框中,点击插件提供的按钮(如
Generate Commit Message
或AI Commit
)。插件将根据你的代码变更自动生成提交信息。比如下面的Fitten的界面
-
提交更改:如果生成的提交信息符合你的预期,点击
Commit
按钮提交更改。
4. 示例
假设你在项目中修改了一个函数并添加了一些注释,AI Commit 插件可能会生成如下提交信息:
feat: improve function documentation and add error handling