先说清楚它是什么：Sourcery 属于「编程与开发」方向的在线服务，AI 代码审查与重构建议工具。

看文档和设置项时遇到的术语，这里用一两句话解释清楚。

术语表

  • 补全（Completion）：在光标处预测下一段代码，速度快但上下文有限。
  • 编程智能体：能读写多个文件、运行命令并迭代修复的 AI，需要控制权限。
  • 上下文索引：把代码库建立索引，让 AI 回答时能引用相关文件。
  • 规则文件：放在仓库里的说明文件，告诉 AI 项目约定和禁止事项。
  • MCP：让编程工具连接外部数据和工具的协议。
  • 差异审阅：在接受 AI 修改前逐个查看 diff，是最重要的安全习惯。

和 Sourcery 相关的补充

  • 在线服务：Sourcery 的产品形态，决定了安装、权限和数据存放方式。
  • 同类产品：CodeRabbit、Qodo、SonarQube。
  • 所属方向：编程与开发。

把概念用起来

代码审查

输入：一个 Pull Request 的改动。

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

交付前确认：问题定位到行。

补充练习

写技术文档

准备材料：一个模块的源码。

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

交付前确认：示例代码可运行。

补单元测试

适用情况：手头有一个缺少测试的函数或模块时。

为【函数名】编写单元测试，覆盖正常输入、边界值和异常输入，使用项目现有的测试框架，不要修改被测代码。先列测试用例再写代码。

交付前确认：测试能在本地通过。

修复报错

适用情况：手头有一段报错堆栈和相关代码时。

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

交付前确认：修改范围足够小。

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

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

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

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

常见问题：生成的代码引用了不存在的函数

让它先搜索代码库确认 API，再写实现；运行测试验证。

概念补充：规则文件

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

概念补充：差异审阅

在接受 AI 修改前逐个查看 diff，是最重要的安全习惯。

适合人群：小店老板

小店老板可以用 Sourcery 处理门店宣传物料、顾客评价回复等工作。需要注意：价格和活动信息以实际为准，顾客电话等信息不要随意上传。

适合人群：科研人员

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

适合人群：研究生

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

写在最后

文中提示词和示例仅作示意，实际效果取决于你的材料和 Sourcery 当前版本，重要内容请人工核对后再使用。

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

延伸阅读