vscode-gptcommit

vscode-gptcommit 项目介绍

vscode-gptcommit 是一款借助 GPT 模型自动生成 git 提交信息的扩展，专为 VS Code 用户设计。在代码管理过程中，它能够快速、智能地生成提交信息，提高开发效率。

安装指南

要开始使用 vscode-gptcommit，用户需要在 VS Code 中完成以下步骤：

• 从 VS Code Marketplace 安装此扩展。
• 安装 gptcommit，但请注意，不要使用 gptcommit install 命令在 git 仓库的根目录安装 gptcommit 钩子。

支持版本

vscode-gptcommit 支持以下版本组合：

确保 VS Code 和 gptcommit 的版本与所用扩展版本兼容。

可用命令

用户可以通过快捷键 Ctrl+Shift+P 或 Cmd+Shift+P 来运行以下命令：

• 生成 Git 提交信息：调用 GPT 模型生成提交信息。
• 设置 OpenAI API Key：配置所需的 OpenAI API 密钥。
• 选择不同的 OpenAI 模型：更换所使用的 OpenAI 模型，默认是 gpt-3.5-turbo。
• 设置输出语言：设定提交信息的输出语言，默认是英文。
• 显示逐文件摘要：是否启用逐文件摘要功能，默认是关闭的。
• 禁用规范化提交：是否禁用规范化提交功能，默认是启用的。
• 打开 gptcommit 配置文件：查看和编辑本地的 gptcommit 配置文件。

扩展设置

vscode-gptcommit 提供了一些个性化设置以满足不同用户需求：

• 快速模式（ExpressMode）：当启用时，生成的信息会直接填写到提交信息输入框内。
• 快速模式内容：设定在快速模式下的信息内容。
  • 如果需要逐文件摘要，须先启用相应功能。
• gptcommit路径：指向 gptcommit 可执行文件的路径。
• 文件对比选项（OnFiles）：选择使用对比哪类文件来生成提交信息。
  • 可选项包括：暂存文件、未暂存文件，以及首先尝试暂存文件然后尝试未暂存文件。

高级配置

用户可以编辑 .git/gptcommit.toml 文件来实现高级配置。为了全局使用这些配置，用户可将文件复制到 ~/.config/gptcommit/config.toml，或者只复制需要的部分。对于更多配置细节，请参考 gptcommit 的文档。

通过使用 vscode-gptcommit，开发者可以更轻松地管理提交历史，与团队共享简洁、准确的代码更改说明，提高协作效率与代码质量。