sourcery

Sourcery 项目介绍

Sourcery - 即时 AI 代码审查工具

Sourcery 是一款旨在帮助开发者加速代码审查过程，提高代码质量，并提升开发速度的自动化代码审查工具。通过 Sourcery，开发者能够在节省审查时间的同时，确保项目代码始终保持高质量。

什么是 Sourcery

Sourcery 是一个自动化的代码审查助手，它能够对 GitHub 上的任意仓库进行代码审查，并针对提交的更改提供即时反馈。每一次审查都包含更改摘要、高级反馈，以及逐行建议或评论（如果相关）。

Sourcery 希望能为用户提供类似团队成员间的代码审查体验，尽管目前尚未完全达到这一目标，但团队正在持续改进，以不断接近这一愿景。

如何开始使用

用户可以将 Sourcery 添加到任意仓库，以便在新提交请求时立即看到审查建议。对于公共仓库和开源项目，Sourcery 是完全免费的。而对于私人仓库，用户可以免费试用 Sourcery 14 天，试用结束后则需要选择一个团队或专业计划。

隐私与安全

为了提供代码审查服务，Sourcery 利用 OpenAI 和 Anthropic 的大型语言模型（LLMs），因此需要将用户代码的一部分（通常是提交请求的差异部分）发送给这些服务。然而，用户的代码不会被 Sourcery 或第三方存储超过 30 天，也不会用于训练任何 AI 模型。

IDE 代码助手

除了代码审查功能外，Sourcery 也可以作为一款自动化的编程助手与开发者协作，帮助开发者理解现有代码（无论是自己最近编写的，还是他人多年前编写的代码），添加单元测试和文档字符串，优化代码的可读性或性能，并通过即时建议提高代码质量。

Sourcery 的安装指南如下：

• PyCharm
• VS Code
• Sublime
• Vim

新的编辑器集成正在开发中。

意见反馈

Sourcery 团队始终致力于改进产品。如果用户有任何想法或建议，可以通过邮箱 hello@sourcery.ai 联系团队。

链接

• Sourcery 官网
• VS Code 插件
• PyCharm 插件

代码徽章

开发者可以使用 Sourcery 提供的徽章，在项目中显示其代码经过 Sourcery 的重构审查。这不仅可以提高项目的专业形象，也让其他人了解到项目在使用先进的代码审查工具。

[![Sourcery](https://img.shields.io/badge/Sourcery-enabled-brightgreen)](https://sourcery.ai)

通过将以上代码添加至 README 文件，即可展示 Sourcery 徽章。