在「编程与开发」类工具里，Sourcery 的定位是：AI 代码审查与重构建议工具。

单独用一个工具往往只解决一段问题，这篇讲怎么把它和上下游工具串起来。

推荐组合：Sourcery + smolagents

smolagents 的定位是：Hugging Face 的轻量代码型智能体库。两者分工可以是：Sourcery 负责「读懂陌生代码库」这一步，smolagents 负责把前后步骤串成自动化流程。

工作流步骤

  1. 明确交付物和验收标准，例如：运行步骤能实际跑通。
  2. 准备输入：一个刚接手的项目仓库，先去掉敏感信息。
  3. 在 Sourcery 中执行核心步骤（提示词见下文）
  4. 把结果交给 smolagents 做下一步处理，或从 smolagents 取得所需材料。
  5. 人工检查关键事实与格式，记录发现的问题。
  6. 把这次用到的提示词和设置保存为模板，下次复用。

读懂陌生代码库

输入：一个刚接手的项目仓库。

先不要改任何代码。请阅读这个仓库，输出：1）目录结构说明；2）主要模块之间的调用关系；3）本地运行步骤；4）你认为最脆弱的 3 个地方。

交付前确认：运行步骤能实际跑通。

交接时最容易出问题的地方

  • 格式不兼容：两边导入导出的格式提前测试一次。
  • 信息丢失：每次交接附上来源和版本号。
  • 责任不清：约定哪一步由谁做最终确认。
  • 权限分散：两边的账号和分享范围分别检查。

如果暂时不想引入第二个工具，也可以先用 SonarQube 等同类产品替代其中一环，跑通流程后再决定。

更多可以试的用法

修复报错

输入：一段报错堆栈和相关代码。

这是报错信息和相关代码。请先解释报错原因，给出最小修改方案，并说明为什么这个修改不会影响其他调用方。

检查点：修改范围足够小。

写技术文档

适用情况：手头有一个模块的源码时。

根据源码为这个模块写 README：用途、安装、最小示例、配置项表格和常见问题。示例代码必须能直接运行。

检查点：示例代码可运行。

代码审查

准备材料：一个 Pull Request 的改动。

审查这个改动，按「必须修改 / 建议修改 / 可以忽略」三级列出问题，每条附上文件和行号，重点关注安全、并发和错误处理。

检查点：问题定位到行。

常见问题：AI 改动范围过大

要求先给计划和文件清单，限定只改指定文件。

常见问题：测试全绿但功能不对

人工补充关键用例，检查测试是否真正断言了结果。

常见问题：泄露密钥的风险

把密钥放在环境变量，规则文件中禁止读取 .env 等敏感文件。

概念补充：规则文件

放在仓库里的说明文件，告诉 AI 项目约定和禁止事项。

概念补充：补全（Completion）

在光标处预测下一段代码，速度快但上下文有限。

适合人群：研究生

研究生可以用 Sourcery 处理文献阅读、开题与论文写作等工作。需要注意：遵守学校学术诚信规定，AI 只用于辅助理解和润色。

适合人群：科研人员

科研人员可以用 Sourcery 处理文献检索与阅读、实验记录与数据整理等工作。需要注意：遵守期刊和机构关于 AI 使用的披露要求，引用逐条核对。

注意事项

涉及个人信息、商业机密或受监管数据时，先确认 Sourcery 的数据处理条款，再决定能否使用。

本文基于 Sourcery 公开的定位与通用用法编写，具体功能、套餐与可用地区以官方页面为准，产品更新后界面和名称可能变化。

延伸阅读