跳转到主要内容

生成提交消息

根据您暂存的 git 更改自动生成描述性提交消息。Kilo Code 会分析您暂存的文件并创建遵循最佳实践的约定式提交消息。

信息

此功能仅分析暂存的更改。在生成提交消息之前，请务必使用 git add 或通过 VS Code 界面暂存您的文件。

工作原理​

git 提交消息生成器：

  • 仅分析您的暂存更改（未暂存或未跟踪的文件）
  • 使用 AI 理解更改的上下文和目的
  • 创建描述性提交消息，解释更改了什么以及为什么遵循约定式提交（默认情况下，可自定义）

使用功能​

生成提交消息​

  1. 使用 git add 或 VS Code git 界面暂存您的更改
  2. 在 VS Code 源代码管理面板中，查找提交消息字段旁边的 Kilo Code 徽标)
  3. 单击徽标以生成提交消息

生成的邮件将出现在提交消息字段中，您可以根据需要进行审查和修改。

生成的提交消息示例

约定式提交格式​

默认情况下，生成的邮件遵循约定式提交规范：

<type>(<scope>): <description>

<body>

常见类型包括：

  • feat：新功能
  • fix：错误修复
  • docs：文档更改
  • style：代码样式更改（格式等）
  • refactor：代码重构
  • test：添加或更新测试
  • chore：维护任务

配置​

自定义提交模板​

您可以通过修改提示模板来自定义提交消息的生成方式：

  1. 单击齿轮图标 → Prompts 打开设置
  2. 找到“提交消息生成”部分
  3. 编辑 Prompt 模板以匹配您项目的约定
提交消息生成设置

默认模板创建约定式提交消息，但您可以修改它以：

  • 使用不同的提交消息格式
  • 包含与您的项目相关的特定信息
  • 遵循您团队的提交消息约定
  • 为 AI 添加自定义指令

API 配置​

您可以配置用于提交消息生成的 API 配置文件：

  1. 在 Prompts 设置中，滚动到“API 配置”
  2. 选择特定配置文件或使用当前选定的配置文件
提示

考虑创建一个专用的 API 配置配置文件，其中包含更快、更具成本效益的模型，专门用于提交消息生成。

最佳实践​

暂存策略​

  • 将相关更改一起暂存，以获得更连贯的提交消息
  • 避免在单个提交中暂存不相关的更改
  • 需要时使用 git add -p 进行部分文件暂存

消息审查​

  • 始终在提交前审查生成的邮件
  • 编辑邮件以添加 AI 可能遗漏的上下文
  • 确保邮件准确描述更改

自定义模板​

  • 根据您的项目需求定制提示模板
  • 包含项目特定的术语或约定
  • 添加处理特定类型更改的说明

生成的示例消息​

以下是该功能可能生成的消息示例：

feat(auth): add OAuth2 integration with Google

Implement Google OAuth2 authentication flow including:
- OAuth2 client configuration
- User profile retrieval
- Token refresh mechanism
fix(api): resolve race condition in user data fetching

Add proper error handling and retry logic to prevent
concurrent requests from causing data inconsistency
docs(readme): update installation instructions

Add missing dependency requirements and clarify
setup steps for new contributors

故障排除​

没有暂存的更改​

如果按钮未出现或生成失败，请确保您已暂存更改：

git add <files>
# 或暂存所有更改
git add .

消息质量差​

如果生成的邮件没有帮助：

  • 审查您的暂存策略 - 不要将不相关的更改一起暂存
  • 使用更具体的指令自定义提示模板
  • 通过 API 配置尝试不同的 AI 模型

集成问题​

该功能与 VS Code 的内置 git 功能集成。如果您遇到问题：

  • 确保您的存储库已正确初始化
  • 检查 VS Code 是否可以访问您的 git 存储库
  • 验证 git 是否已安装并可从 VS Code 访问

相关功能​

Is this documentation incorrect or incomplete? Report an issue on GitHub