用 CodeRabbit 完成第一个小项目:完整演练
CodeRabbit 是一款在线服务:在 Pull Request 上自动做 AI 代码审查的服务。
与其看十篇介绍,不如完整做一个小项目,这篇带你走一遍。
项目:读懂陌生代码库
目标:用 CodeRabbit 完成一次「读懂陌生代码库」,交付一份可以直接给同事或客户看的结果。预计用时 1 小时以内。
步骤
- 用工作邮箱注册,开启双重验证。
- 准备材料:一个刚接手的项目仓库(先脱敏)
- 复制下面的提示词,替换方括号内容。
- 第一次结果出来后,只针对一个问题追问修改。
- 按验收标准检查:运行步骤能实际跑通。
- 保存提示词与最终结果,写三行复盘。
先不要改任何代码。请阅读这个仓库,输出:1)目录结构说明;2)主要模块之间的调用关系;3)本地运行步骤;4)你认为最脆弱的 3 个地方。
复盘模板
这次任务:
节省或多花的时间:
需要人工修改的地方:
下次会改进的提示:
是否继续使用:
做完之后
可以尝试第二个任务「补单元测试」,或者把这次的流程分享给同事一起试。
补充练习
写技术文档
准备材料:一个模块的源码。
根据源码为这个模块写 README:用途、安装、最小示例、配置项表格和常见问题。示例代码必须能直接运行。
验收标准:示例代码可运行。
代码审查
准备材料:一个 Pull Request 的改动。
审查这个改动,按「必须修改 / 建议修改 / 可以忽略」三级列出问题,每条附上文件和行号,重点关注安全、并发和错误处理。
验收标准:问题定位到行。
小功能开发
输入:一个清晰的需求描述。
实现以下需求:【需求】。要求:先给出实现计划和要改动的文件列表,等我确认后再写代码;遵循现有代码风格;补充必要的测试。
验收标准:先有计划再动手。
常见问题:AI 改动范围过大
要求先给计划和文件清单,限定只改指定文件。
常见问题:测试全绿但功能不对
人工补充关键用例,检查测试是否真正断言了结果。
常见问题:泄露密钥的风险
把密钥放在环境变量,规则文件中禁止读取 .env 等敏感文件。
概念补充:补全(Completion)
在光标处预测下一段代码,速度快但上下文有限。
概念补充:MCP
让编程工具连接外部数据和工具的协议。
适合人群:小店老板
小店老板可以用 CodeRabbit 处理门店宣传物料、顾客评价回复等工作。需要注意:价格和活动信息以实际为准,顾客电话等信息不要随意上传。
适合人群:设计师
设计师可以用 CodeRabbit 处理灵感与草图、多尺寸物料适配等工作。需要注意:确认生成素材与字体的商用授权,客户未公开的项目不要上传。
适合人群:研究生
研究生可以用 CodeRabbit 处理文献阅读、开题与论文写作等工作。需要注意:遵守学校学术诚信规定,AI 只用于辅助理解和润色。
使用提醒
本文基于 CodeRabbit 公开的定位与通用用法编写,具体功能、套餐与可用地区以官方页面为准,产品更新后界面和名称可能变化。
所有示例输出均为示意,不代表真实统计或效果承诺;请以自己的测试结果为准。