mirror of
https://github.com/Sea-Haven-Industries/engineering-handbook.git
synced 2026-09-30 06:53:15 +00:00
Add deferred findings policy to code review page
Require PR authors to create a GitHub issue for any review finding deferred past the current PR, and link it in the review thread before merging. Prevents informal tracking from dropping items.
This commit is contained in:
parent
651dff5dd3
commit
7d5d04985a
1 changed files with 14 additions and 0 deletions
|
|
@ -34,6 +34,20 @@ Code review exists to catch defects, share knowledge, and maintain consistency.
|
||||||
- Ask questions instead of making assumptions. "Is this intentional?" is better than "This is wrong."
|
- Ask questions instead of making assumptions. "Is this intentional?" is better than "This is wrong."
|
||||||
- If a PR is good, say so. A simple "Looks good" is fine.
|
- If a PR is good, say so. A simple "Looks good" is fine.
|
||||||
|
|
||||||
|
## Deferred Findings
|
||||||
|
|
||||||
|
When a reviewer identifies a finding that won't be addressed in the current PR, the PR author must create a GitHub issue for it before the PR merges. No exceptions -- if it's worth commenting on, it's worth tracking.
|
||||||
|
|
||||||
|
### Requirements
|
||||||
|
|
||||||
|
- The GitHub issue must reference the PR number and link to the specific review comment.
|
||||||
|
- The PR author must reply to the review comment with a link to the created issue, acknowledging the deferral.
|
||||||
|
- This applies to all severity levels: bugs, nits, refactors, missing tests, documentation gaps.
|
||||||
|
|
||||||
|
### Why
|
||||||
|
|
||||||
|
Deferred findings handled informally (retro notes, mental to-do lists, "we'll get to it") fall through the cracks. An issue in the backlog is the minimum bar for accountability.
|
||||||
|
|
||||||
## Turnaround
|
## Turnaround
|
||||||
|
|
||||||
- Aim to review within one business day of being requested
|
- Aim to review within one business day of being requested
|
||||||
|
|
|
||||||
Loading…
Add table
Reference in a new issue