广告位招商中 欢迎洽谈
简体中文
English简体中文繁體中文日本語EspañolPortuguês한국어DeutschFrançais
全网站点

如何使用 JetBrains AI Assistant 在 IDE 版本控制工作流中自动生成提交信息与 PR 描述

观察
365Finds Editorial
已收录 11,430 篇 Wiki 文章

让你的 AI 用上 365 Wiki

复制这段快捷提示词，粘贴到你正在使用的 AI 对话中，然后继续提问。AI 会搜索 365 Wiki，帮你查资料、比较方案并给出建议。

下载完整 Skill

偶尔使用，快捷提示词就够了。经常使用，安装 365Wiki Skill：无需每次复制，还能更完整地研究问题、比较选择并规划下一步。没有常用工具？Gemini、Microsoft Copilot 等网页版 AI 也能使用。

365Wiki Skill

下载完整 Skill
编写清晰、规范的 Git 提交说明（Commit Message）与 Pull Request（PR）描述是团队协作与项目维护的关键，但在频繁的代码修改与分支切换中，手动组织说明往往消耗开发者的专注度。JetBrains AI Assistant 原生集成于 IntelliJ IDEA、PyCharm、WebStorm、GoLand 等 JetBrains IDE 的版本控制工具窗口，支持根据代码差异自动生成符合规范的提交信息、发起提交前 AI 自检、并一键生成结构化的 PR/MR 标题与说明。


本文将详细介绍如何在 JetBrains IDE 的版本控制流程中配置与使用 AI Assistant 自动编写 Commit 说明与 PR 描述，定制符合团队规范的提示词模板，并配合冲突合并与代码审查工具提升研发效能。




前提条件与环境准备


在开始使用版本控制相关 AI 功能之前，请确认开发环境满足以下要求：


    

  1. 兼容的 JetBrains IDE：版本为 2024.1 或更高版本（如 IntelliJ IDEA、PyCharm、WebStorm、GoLand、CLion、Rider 等）。
    2. 

  2. AI Assistant 插件与有效订阅：

      

    • 确保已在 Settings | Plugins（Windows/Linux 快捷键 Ctrl+Alt+S，macOS 快捷键 Cmd+,）中启用 JetBrains AI Assistant 插件。
      • 

    • 登录 JetBrains 账户，并拥有可用配额（支持 AI Free 体验配额、AI Pro 个人订阅、AI Ultimate 或企业组织分配的许可证）。
      • 

    

    3. 

  3. 版本控制插件就绪：

      

    • 项目已初始化 Git 或 Mercurial 仓库。
      • 

    • 开启 IDE 内置的 Git 以及 GitHub（或 GitLab）插件，以启用对应的 Pull Requests / Merge Requests 工具窗口。
      • 

    

    4. 





1. 使用 AI Assistant 自动生成提交信息（Commit Messages）


JetBrains AI Assistant 会分析暂存区（Staged Area）或选定修改列表（Changelist）中的代码 Diff，自动总结变更内容与动机，生成结构清晰的提交说明。


操作步骤


    

  1. 打开 Commit 工具窗口：

      

    • 使用快捷键 Alt+0（Windows/Linux）或 Cmd+0（macOS），或直接按 Ctrl+K / Cmd+K。
      • 

    

    2. 

  2. 勾选本次提交的代码变更：

      

    • 勾选准备提交的文件、代码块或变更集。AI Assistant 仅针对勾选的具体 Diff 进行分析，因此非常适合精确的小粒度提交。
      • 

    

    3. 

  3. 点击 AI 生成按钮：

      

    • 在提交信息输入框上方，点击带有闪烁图标的 Generate Commit Message with AI Assistant 按钮。
      • 

    

    4. 

  4. 检查并调整生成文本：

      

    • AI Assistant 将自动填充包含首行摘要和详细要点的说明内容。
      • 

    • 开发者可根据需要补充关联的 Issue 编号（例如 PROJ-1024）或破坏性改动说明，确认无误后提交（快捷键 Ctrl+Enter 或 Cmd+Enter）。
      • 

    

    5. 



Add JWT authentication middleware and token expiration check

- Introduce AuthTokenValidator class to verify bearer tokens
- Register authentication interceptor in security configuration
- Add unit test coverage for expired and malformed tokens





2. 自定义提交信息规范与提示词模板


不同开发团队通常有统一的提交格式规范，例如 Conventional Commits（约定式提交：feat:, fix:, docs:, refactor:）、字符长度限制或包含当前分支名。JetBrains 提供了两种灵活的定制方式：


方式一：在 Commit 窗口直接配置


    

  1. 点击 Commit 工具窗口右下角的齿轮图标（Settings）。
    2. 

  2. 展开 AI Assistant 选项，在 Prompt for generation 字段中输入指令。
    3. 

  3. 可使用系统内置变量 $GIT_BRANCH_NAME 将分支名信息传递给 AI（例如：提取 $GIT_BRANCH_NAME 中的任务编号作为前缀，并按要点罗列修改）。
    4. 



方式二：在全局 Prompt Library 中统一定制


    

  1. 打开 Settings | Tools | AI Assistant | Prompt Library（Ctrl+Alt+S 或 Cmd+,）。
    2. 

  2. 在 Built-In Actions 列表中选择 Commit Message Generation。
    3. 

  3. 在右侧规则编辑器中定义具体的格式约束：

      

    • 约定格式：例如“严格遵循 Conventional Commits 格式，首行为类型加简短描述”。
      • 

    • 长度控制：例如“首行摘要不超过 50 字符，换行后正文每行不超过 72 字符”。
      • 

    • 输出语言：可指定生成简体中文或英文说明。
      • 

    

    4. 

  4. 点击 Apply 保存。后续所有生成操作都将严格遵循该规则。
    5. 





3. 提交前 AI 自检（Self-Review with AI）


为了防止意外将调试代码、敏感配置或低级语法错误带入仓库，AI Assistant 提供了提交前代码自检功能：


    

  1. 在 Commit 窗口中勾选待提交的变更。
    2. 

  2. 点击 Self-Review with AI 按钮。
    3. 

  3. IDE 会在 Problems 工具窗口的 AI Self-Review 标签页中列出潜在问题：

      

    • 遗留的调试打印语句（如未删除的 console.log 或 System.out.println）。
      • 

    • 潜在的空指针异常、未捕获的边界情况或资源泄露风险。
      • 

    • 代码风格不一致与变量命名不规范。
      • 

    

    4. 

  4. 双击列表项或按 F4 跳转至源码行，可直接应用 IDE 建议的快速修复（Quick Fix）。
    5. 

  5. 团队还可在 Settings | Tools | AI Assistant | Project Settings 的 Path to rules for AI Self-Review 中指定自定义 Markdown 规范文件，让 AI 依据企业内部代码规范进行审查。
    6. 





4. 编辑与改进已有的历史提交说明


如果已经完成本地提交但尚未推送到远端，发现说明不够准确时，同样可以使用 AI 进行重写：


    

  1. 按 Alt+9（Windows/Linux）或 Cmd+9（macOS）打开 Git Log / Version Control 窗口。
    2. 

  2. 在提交记录列表中右键单击需要修改的提交，选择 Edit Commit Message。
    3. 

  3. 在弹出的对话框中，点击 Improve Commit Message with AI Assistant。
    4. 

  4. AI 将重新评估该次提交的 Diff 并生成更准确的描述，点击 OK 保存后再推送分支（Ctrl+Shift+K 或 Cmd+Shift+K）。
    5. 





5. 自动生成 Pull Request 与 Merge Request 描述


完成特性开发并推送到远端后，在 IDE 内发起代码审查时，AI Assistant 能够综合整个分支的改动生成详尽的 PR 描述。


创建 PR/MR 时生成描述


    

  1. 打开 Pull Requests 工具窗口：

      

    • 在主菜单中选择 Git | GitHub | View Pull Requests（或 GitLab | View Merge Requests）。
      • 

    

    2. 

  2. 新建 Pull Request：

      

    • 点击 + 号创建新的 PR/MR，选择基准分支（Base Branch）与特性分支（Head Branch）。
      • 

    

    3. 

  3. 一键生成标题与正文：

      

    • 在描述编辑框中点击 Generate a Title and Description with AI Assistant。
      • 

    • AI 将分析分支间的所有提交与文件改动，生成结构化 Markdown 正文，通常涵盖：

        

      • 概述（Summary）：本次 PR 解决的核心业务问题或功能背景。
        • 

      • 关键改动（Key Changes）：涉及模块的具体实现要点。
        • 

      • 验证方式（Verification）：自动化测试与验证步骤建议。
        • 

      

      • 

    

    4. 

  4. 补充与提交：

      

    • 补充关联的 Issue 链接或审查注意事项后，点击 Create Pull Request 即可完成发布。
      • 

    

    5. 



审查他人 PR 时的自动摘要


在审查团队成员提交的 PR 时，AI Assistant 还可以提供一键摘要：





最佳实践与建议



























实践原则收益与操作建议
保持小粒度提交（Partial Commit）配合 IDE 的行级选区提交功能，向 AI 提供聚焦的小 Diff，能获得远比大杂烩提交更精准的说明。
核对外部关联标识AI 能准确理解代码变动，但无法预知外部任务看板（如 Jira、Linear）的编号，需结合 $GIT_BRANCH_NAME 或手动补充。
结合 IDE 内置代码检查将 AI 生成与 IDE 的 Commit Checks（代码格式化、优化导入、代码检查）组合使用，保障提交质量。
在冲突处理中使用 Merge with AI在分支变基或合并发生冲突时，在 Merge Revisions 弹窗中点击 Merge with AI，可智能融合非结构性代码冲突。


通过在日常版本控制流程中运用 JetBrains AI Assistant，开发团队既能免去手动编写冗长描述的心智负担，又能沉淀出规范、易读、可追溯的代码提交历史。




参考资料


涉及产品
JetBrains AI