Skip to content

docs: add review comment checklist #76

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
cschanhniem merged 1 commit into from
Jul 6, 2026
Merged

docs: add review comment checklist #76

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions docs/REVIEW-COMMENT-CHECKLIST.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Review Comment Checklist

Open Problem Lab should make review comments actionable.

Use this checklist when leaving a blocking or important review comment.

```markdown
## Review comment checklist

**Issue type:** source | method | boundary | status | field context | generated output | structure.

**What must change:** One concrete action.

**Why it matters:** One sentence.

**Suggested fix:** Optional path forward.

**Blocks merge?** yes | no | only blocks confidence upgrade.
```

## Acceptance test

A review comment is useful when the contributor can tell what to change, why it matters, and whether it blocks merge.
Loading