reviewing-patches.rst (1014B)
1 Reviewing and merging patches 2 ============================= 3 4 Everyone is encouraged to review open pull requests. We only ask that you try 5 and think carefully, ask questions and are `excellent to one another`_. Code 6 review is our opportunity to share knowledge, design ideas and make friends. 7 8 When reviewing a patch try to keep each of these concepts in mind: 9 10 Architecture 11 ------------ 12 13 * Is the proposed change being made in the correct place? 14 15 Intent 16 ------ 17 18 * What is the change being proposed? 19 * Do we want this feature or is the bug they're fixing really a bug? 20 21 Implementation 22 -------------- 23 24 * Does the change do what the author claims? 25 * Are there sufficient tests? 26 * Has it been documented? 27 * Will this change introduce new bugs? 28 29 Grammar and style 30 ----------------- 31 32 These are small things that are not caught by the automated style checkers. 33 34 * Does a variable need a better name? 35 * Should this be a keyword argument? 36 37 .. _`excellent to one another`: https://speakerdeck.com/ohrite/better-code-review