Skip to content

Commit 7127b2d

Browse files
authored
Update CODE_REVIEW.md
1 parent 40eb523 commit 7127b2d

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

guides/CODE_REVIEW.md

+6-4
Original file line numberDiff line numberDiff line change
@@ -25,14 +25,16 @@ This is probably the more common one that people think of when it comes to code
2525

2626
The key goals they need to ask themselves when reviewing code:
2727

28-
> Will this break production?
29-
> Can someone else reasonably maintain this later?
28+
> **Q1**: Will this break production?
29+
>
30+
> **Q2**: Can someone else reasonably maintain this later?
3031
3132
Sometimes a solution isn't exactly how you would expect it to be solved, that is ok. As a reviewer you should be open to letting these through. This is to help avoid nitpicking.
3233

33-
**Nitpicking should never block code getting released**.
34+
⚠️ **Nitpicking should never block code getting released**. ⚠️
3435

35-
The regulating factor here is that if the code could not reasonably be maintained by someone else, then that is leaving tech debt and lowering the bar for the whole project.
36+
The regulating factor is that if "_the code could not reasonably be maintained by someone else_", then that is leaving tech debt and lowering the bar for the whole project.
37+
These should get addressed.
3638

3739
## Before Code Review
3840

0 commit comments

Comments
 (0)