产品简介
The AI assistant for your pull requests(此前称为What The Diff)是一款专注于提升代码审查效率的人工智能应用。作为GitHub和GitLab平台上的集成应用,它旨在解决开发过程中拉取请求(Pull Requests, PR)审查耗时且难以被非技术人员理解的问题。通过利用先进的AI模型,该工具能够读取代码差异(diff),并将其转化为清晰、自然的语言描述,从而让代码变更对所有人透明化。
核心功能
该产品提供了一系列自动化功能,以减轻开发者的负担并改善团队沟通:
- 自动化PR描述生成:AI自动执行撰写变更描述的繁琐工作,为每次代码提交生成详细的说明。
- 丰富的摘要通知:提供简化和翻译后的变更摘要,确保非技术背景的利益相关者也能及时了解项目进展。
- 精美的变更日志:支持分享公开的变更日志,或通过JSON API供内部系统调用,方便追踪所有更改。
- 每周进度报告:定期接收包含整周所有变更摘要的进度报告,帮助团队掌握整体开发节奏。
特色能力:内联AI重构
除了生成描述外,该工具还具备内联AI重构能力。在代码审查过程中,它不仅能指出问题,还能在AI的支持下直接提供重构建议或代码改进方案,而不仅仅是留下评论让他人修改。这种主动式的辅助方式显著提升了代码质量和审查效率。
工作方式与隐私安全
该应用通过GitHub或GitLab API获取拉取请求的代码差异,然后使用AI模型生成变更描述。关于用户关心的数据隐私问题,官方明确声明不存储用户的代码或PR差异数据,第三方服务也不会存储这些数据。AI模型不会使用用户的代码进行训练。由于平台权限限制,应用需要完整的代码访问权限才能读取PR差异,但数据处理过程仅在内存中进行,确保持久化存储中无代码留存。
适用人群与场景
本产品主要适用于以下群体和场景:
- 软件开发团队:希望减少编写PR描述的时间,专注于核心逻辑开发。
- 技术负责人:需要快速了解大型PR的影响,或向管理层汇报进度。
- 跨职能团队:产品经理或非技术人员需要理解代码变更对业务的影响,而无需深入阅读代码。
- 多语言开发环境:支持几乎所有编程语言,并能将解释翻译成多种语言,适合国际化团队。
使用建议与配置
为了获得最佳体验,用户可以利用细粒度的设置选项来优化资源使用:
- 跳过CI构建:对于不需要持续集成检查的PR,可以配置跳过以节省资源。
- 延迟草稿处理:对于处于草稿状态的PR,可以延迟处理直到标记为就绪。
- 令牌消耗限制:用户可以监控和限制令牌(Token)的使用量,避免意外超额。平均每个PR约消耗2,300个令牌,具体取决于差异大小。
常见问题
如果令牌用完了怎么办?
如果您的令牌用完,可以选择升级到更大的计划,或者等待下一个计费周期重置。系统不会自动升级您的计划,您需要手动操作。未使用的令牌不会累积到下个月,因此建议根据实际需求选择最小的计划,并在需要时随时升级或降级。
支持哪些编程语言?
该工具支持几乎所有的编程语言。AI模型能够识别代码差异并用通俗英语(或其他支持的语言)解释变更内容。无论您使用的是Python、JavaScript、Java还是其他语言,都能获得准确的描述。
为什么需要完整的代码访问权限?
目前GitHub和GitLab没有仅提供“读取PR差异”的细粒度权限。为了能够读取和分析拉取请求中的代码差异,应用必须请求完整的代码访问权限。请放心,官方承诺不存储任何代码数据,权限仅用于实时处理差异。
