Skip to content

Commit 501c1d5

Browse files
DCjanuscodex
andcommitted
docs(skills): document coderabbit long-running behavior
Co-authored-by: OpenAI Codex <codex@openai.com>
1 parent 5aba2c1 commit 501c1d5

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

skills/coderabbit-cli/SKILL.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,9 @@ description: 指导如何使用 CodeRabbit CLI 进行 Code Review。
1212
- 只有在确实需要阅读纯文本 review 原文时,才使用 `--plain`
1313
- 每次只 review 和当前任务直接相关的 diff,避免把无关改动混进审查范围。
1414
- 单次 review 可能较慢,且存在频率限制;不要在短时间内重复触发多轮无意义审查。
15+
- 当前 CLI 未提供明确的流式输出、进度或超时参数;将 `coderabbit review` 视为长任务处理,不要假设会持续输出日志。
16+
- 运行长时间 review 前,先向用户说明可能需要数分钟到更久;执行期间定期汇报仍在等待结果,避免用户误以为已卡死。
17+
- 如需外层超时控制,使用 shell 的超时机制包裹命令,而不是假设 `coderabbit` 自带 `--timeout`
1518
- 对用户汇报时,优先总结 CodeRabbit 的有效发现,不要直接大段转储原始输出。
1619
- 向用户汇报整理后的待处理项时,使用数字编号,方便用户按编号指定后续处理项。
1720
- 如果 CodeRabbit 的建议与代码现状或任务目标冲突,agent 应自行判断并说明取舍理由。
@@ -26,6 +29,7 @@ coderabbit review --prompt-only --base <default-branch> # 审查当前分支相
2629
coderabbit review --prompt-only --base-commit HEAD~3 # 审查 HEAD~3 之后引入的改动
2730
coderabbit review --prompt-only --base <default-branch> --config coderabbit.yaml # 基于默认分支审查,并追加仓库内 review 指令文件
2831
coderabbit review --prompt-only --cwd /abs/path/to/repo --base <default-branch> # 指定目标仓库目录,并相对默认分支审查
32+
timeout 30m coderabbit review --prompt-only --base <default-branch> # 在 shell 外层限制最长等待时间
2933
```
3034

3135
## 参考

0 commit comments

Comments
 (0)