Skip to content

Commit 42ff03b

Browse files
authored
[agents] Update review guidelines for TODOs (#2967)
Addresses #2966 (comment)
1 parent 5e3d16e commit 42ff03b

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

agent_docs/reviewing.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,14 @@ resolved. When you encounter a `TODO` comment:
9292
be resolved*.
9393
2. **Critique** only if the `TODO` is insufficient (i.e., the code would still
9494
be problematic *even if* the `TODO` were resolved).
95+
3. **Safety Placeholders:** A `// SAFETY: TODO` comment is a valid placeholder
96+
for a safety comment, and a `/// TODO` comment in a `/// # Safety` doc
97+
section is a valid placeholder for safety documentation. **DO NOT** flag
98+
the first as a missing safety justification or a critical issue, and **DO
99+
NOT** flag the second as missing safety documentation. You must assume the
100+
author will write a sound justification or accurate safety documentation
101+
before merging.
102+
95103
<!-- TODO-check-enable -->
96104

97105
## 4. Anti-Patterns (NEVER Do This)

0 commit comments

Comments
 (0)