Sourcery 故障与效果问题处理指南
Sourcery 是一款在线服务:AI 代码审查与重构建议工具。
下面按「现象 → 可能原因 → 处理办法」整理常见问题。
排查表
| 现象 | 处理办法 |
|---|---|
| AI 改动范围过大 | 要求先给计划和文件清单,限定只改指定文件。 |
| 生成的代码引用了不存在的函数 | 让它先搜索代码库确认 API,再写实现;运行测试验证。 |
| 越改越乱 | 回滚到上一个可用提交,把需求拆小后重新开始。 |
| 泄露密钥的风险 | 把密钥放在环境变量,规则文件中禁止读取 .env 等敏感文件。 |
| 测试全绿但功能不对 | 人工补充关键用例,检查测试是否真正断言了结果。 |
通用排查顺序
- 确认账号、额度和网络状态正常。
- 用一份简单材料复现问题,排除材料本身的干扰。
- 检查设置是否被改动(模型、语言、格式等)
- 查看官方状态页或更新日志。
- 仍无法解决时整理复现步骤联系官方支持。
用标准任务做对照测试
修复报错
输入:一段报错堆栈和相关代码。
这是报错信息和相关代码。请先解释报错原因,给出最小修改方案,并说明为什么这个修改不会影响其他调用方。
检查点:修改范围足够小。
补充练习
代码审查
输入:一个 Pull Request 的改动。
审查这个改动,按「必须修改 / 建议修改 / 可以忽略」三级列出问题,每条附上文件和行号,重点关注安全、并发和错误处理。
检查点:问题定位到行。
补单元测试
适用情况:手头有一个缺少测试的函数或模块时。
为【函数名】编写单元测试,覆盖正常输入、边界值和异常输入,使用项目现有的测试框架,不要修改被测代码。先列测试用例再写代码。
检查点:测试能在本地通过。
写技术文档
准备材料:一个模块的源码。
根据源码为这个模块写 README:用途、安装、最小示例、配置项表格和常见问题。示例代码必须能直接运行。
验收标准:示例代码可运行。
常见问题:测试全绿但功能不对
人工补充关键用例,检查测试是否真正断言了结果。
常见问题:生成的代码引用了不存在的函数
让它先搜索代码库确认 API,再写实现;运行测试验证。
常见问题:泄露密钥的风险
把密钥放在环境变量,规则文件中禁止读取 .env 等敏感文件。
概念补充:MCP
让编程工具连接外部数据和工具的协议。
概念补充:差异审阅
在接受 AI 修改前逐个查看 diff,是最重要的安全习惯。
适合人群:小店老板
小店老板可以用 Sourcery 处理门店宣传物料、顾客评价回复等工作。需要注意:价格和活动信息以实际为准,顾客电话等信息不要随意上传。
适合人群:软件工程师
软件工程师可以用 Sourcery 处理代码阅读与重构、测试与排错等工作。需要注意:不要把密钥和未开源代码上传到未授权工具,合并前审阅每处改动。
适合人群:咨询顾问
咨询顾问可以用 Sourcery 处理行业研究、访谈整理等工作。需要注意:客户机密遵守保密协议,研究结论注明来源。
注意事项
涉及个人信息、商业机密或受监管数据时,先确认 Sourcery 的数据处理条款,再决定能否使用。
文中提示词和示例仅作示意,实际效果取决于你的材料和 Sourcery 当前版本,重要内容请人工核对后再使用。