Skip to content

Commit 1d486fb

Browse files
tiancaiamaoshenli
authored andcommitted
Format checklist.md (pingcap#3382)
1 parent cae65ff commit 1d486fb

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

checklist.md

+6
Original file line numberDiff line numberDiff line change
@@ -2,21 +2,27 @@
22

33
# Self Review
44
Have you reviewed every line of your changes by yourself?
5+
56
# Test
67
Have you added enough test cases to cover the new feature or bug fix?
78
Also, add comments to describe your test cases.
9+
810
# Naming
911
Do function names keep consistent with its behavior?
1012
Is it easy to infer the function's behavior by its name?
13+
1114
# Comment
1215
Is there any code that confuses the reviewer?
1316
Add comments on them! You'll be asked to do so anyway.
1417
Make sure there is no syntax or spelling error in your comments.
1518
Some online syntax checking tools like Grammarly may be helpful.
19+
1620
# Refactor
1721
Is there any way to refactor the code to make it more readable?
1822
If the refactoring touches a lot of existing code, send another PR to do it.
23+
1924
# Single Purpose
2025
Make sure the PR does only one thing and nothing else.
26+
2127
# Diff Size
2228
Make sure the diff size is no more than 500, split it into small PRs if it is too large.

0 commit comments

Comments
 (0)