Skip to content

Commit 2755880

Browse files
authored
docs: clarify bot review conversation ownership (#39942)
* docs: clarify bot review conversations
1 parent 0af3118 commit 2755880

File tree

3 files changed

+21
-1
lines changed

3 files changed

+21
-1
lines changed

.github/pull_request_template.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,13 @@ What you personally verified (not just CI), and how:
8787
- Edge cases checked:
8888
- What you did **not** verify:
8989

90+
## Review Conversations
91+
92+
- [ ] I replied to or resolved every bot review conversation I addressed in this PR.
93+
- [ ] I left unresolved only the conversations that still need reviewer or maintainer judgment.
94+
95+
If a bot review conversation is addressed by this PR, resolve that conversation yourself. Do not leave bot review conversation cleanup for maintainers.
96+
9097
## Compatibility / Migration
9198

9299
- Backward compatible? (`Yes/No`)

AGENTS.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
- GitHub comment footgun: never use `gh issue/pr comment -b "..."` when body contains backticks or shell chars. Always use single-quoted heredoc (`-F - <<'EOF'`) so no command substitution/escaping corruption.
77
- GitHub linking footgun: don’t wrap issue/PR refs like `#24643` in backticks when you want auto-linking. Use plain `#24643` (optionally add full URL).
88
- PR landing comments: always make commit SHAs clickable with full commit links (both landed SHA + source SHA when present).
9+
- PR review conversations: if a bot leaves review conversations on your PR, address them and resolve those conversations yourself once fixed. Leave a conversation unresolved only when reviewer or maintainer judgment is still needed; do not leave bot-conversation cleanup to maintainers.
910
- GitHub searching footgun: don't limit yourself to the first 500 issues or PRs when wanting to search all. Unless you're supposed to look at the most recent, keep going until you've reached the last page in the search
1011
- Security advisory analysis: before triage/severity decisions, read `SECURITY.md` to align with OpenClaw's trust model and design boundaries.
1112

CONTRIBUTING.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,8 +74,19 @@ Welcome to the lobster tank! 🦞
7474
- Ensure CI checks pass
7575
- Keep PRs focused (one thing per PR; do not mix unrelated concerns)
7676
- Describe what & why
77+
- Reply to or resolve bot review conversations you addressed before asking for review again
7778
- **Include screenshots** — one showing the problem/before, one showing the fix/after (for UI or visual changes)
7879

80+
## Review Conversations Are Author-Owned
81+
82+
If a review bot leaves review conversations on your PR, you are expected to handle the follow-through:
83+
84+
- Resolve the conversation yourself once the code or explanation fully addresses the bot's concern
85+
- Reply and leave it open only when you need maintainer or reviewer judgment
86+
- Do not leave "fixed" bot review conversations for maintainers to clean up for you
87+
88+
This applies to both human-authored and AI-assisted PRs.
89+
7990
## Control UI Decorators
8091

8192
The Control UI uses Lit with **legacy** decorators (current Rollup parsing does not support
@@ -101,8 +112,9 @@ Please include in your PR:
101112
- [ ] Note the degree of testing (untested / lightly tested / fully tested)
102113
- [ ] Include prompts or session logs if possible (super helpful!)
103114
- [ ] Confirm you understand what the code does
115+
- [ ] Resolve or reply to bot review conversations after you address them
104116

105-
AI PRs are first-class citizens here. We just want transparency so reviewers know what to look for.
117+
AI PRs are first-class citizens here. We just want transparency so reviewers know what to look for. If you are using an LLM coding agent, instruct it to resolve bot review conversations it has addressed instead of leaving them for maintainers.
106118

107119
## Current Focus & Roadmap 🗺
108120

0 commit comments

Comments
 (0)