| Alex Stapleton | c5fffd3 | 2014-03-18 15:29:00 +0000 | [diff] [blame] | 1 | Reviewing/merging patches |
| Paul Kehrer | 0839aa8 | 2014-02-11 22:36:51 -0600 | [diff] [blame] | 2 | ========================= |
| 3 | |
| Paul Kehrer | 91c776f | 2014-02-11 23:08:47 -0600 | [diff] [blame] | 4 | Everyone is encouraged to review open pull requests. When reviewing a patch try |
| 5 | to keep each of these concepts in mind: |
| Paul Kehrer | 0839aa8 | 2014-02-11 22:36:51 -0600 | [diff] [blame] | 6 | |
| 7 | Architecture |
| 8 | ------------ |
| 9 | |
| 10 | * Is the proposed change being made in the correct place? Is it a fix in a |
| 11 | backend when it should be in the primitives? |
| 12 | |
| 13 | Intent |
| 14 | ------ |
| 15 | |
| 16 | * What is the change being proposed? |
| 17 | * Do we want this feature or is the bug they're fixing really a bug? |
| 18 | |
| 19 | Implementation |
| 20 | -------------- |
| 21 | |
| 22 | * Does the change do what the author claims? |
| 23 | * Are there sufficient tests? |
| 24 | * Has it been documented? |
| 25 | * Will this change introduce new bugs? |
| 26 | |
| 27 | Grammar/Style |
| 28 | ------------- |
| 29 | |
| 30 | These are small things that are not caught by the automated style checkers. |
| 31 | |
| 32 | * Does a variable need a better name? |
| 33 | * Should this be a keyword argument? |
| Paul Kehrer | 91c776f | 2014-02-11 23:08:47 -0600 | [diff] [blame] | 34 | |
| Alex Stapleton | c5fffd3 | 2014-03-18 15:29:00 +0000 | [diff] [blame] | 35 | Merge requirements |
| Paul Kehrer | 91c776f | 2014-02-11 23:08:47 -0600 | [diff] [blame] | 36 | ------------------ |
| 37 | |
| 38 | Because cryptography is so complex, and the implications of getting it wrong so |
| 39 | devastating, ``cryptography`` has a strict merge policy for committers: |
| 40 | |
| 41 | * Patches must *never* be pushed directly to ``master``, all changes (even the |
| 42 | most trivial typo fixes!) must be submitted as a pull request. |
| 43 | * A committer may *never* merge their own pull request, a second party must |
| 44 | merge their changes. If multiple people work on a pull request, it must be |
| 45 | merged by someone who did not work on it. |
| 46 | * A patch that breaks tests, or introduces regressions by changing or removing |
| 47 | existing tests should not be merged. Tests must always be passing on |
| 48 | ``master``. |
| 49 | * If somehow the tests get into a failing state on ``master`` (such as by a |
| 50 | backwards incompatible release of a dependency) no pull requests may be |
| 51 | merged until this is rectified. |
| 52 | * All merged patches must have 100% test coverage. |
| 53 | |
| 54 | The purpose of these policies is to minimize the chances we merge a change |
| 55 | that jeopardizes our users' security. |
| 56 | |