@@ -41,47 +41,53 @@ Documentation
41
41
PR Review guidelines
42
42
====================
43
43
44
+ * Be patient and `kind <https://youtu.be/tzFWz5fiVKU?t=49m30s >`__ with
45
+ contributors.
46
+
44
47
* If you have commit rights, then you are trusted to use them. Please
45
48
help review and merge PRs!
46
49
47
- * For code changes (anything in ``src `` or ``lib ``) two developers
48
- (those with commit rights) should review all pull requests. If you
49
- are the first to review a PR and approve of the changes use the
50
- github `'approve review'
50
+ * Documentation and examples may be merged by the first reviewer. Use
51
+ the threshold "is this better than it was?" as the review criteria.
52
+
53
+ * For code changes (anything in ``src `` or ``lib ``) at least two
54
+ developers (those with commit rights) should review all pull
55
+ requests. If you are the first to review a PR and approve of the
56
+ changes use the github `'approve review'
51
57
<https://help.github.com/articles/reviewing-changes-in-pull-requests/> `__
52
58
tool to mark it as such. If you are a subsequent reviewer and you
53
59
approve, either merge (and backport if needed) or select ``'approve
54
- review' ``.
60
+ review' `` if you think further review is required .
55
61
56
62
Ensure that all API changes are documented in
57
63
:file: `doc/api/api_changes ` and significant new features have and
58
64
entry in :file: `doc/user/whats_new `.
59
65
60
- * Documentation and examples may be merged by the first reviewer. Use
61
- the threshold "is this better than it was?" as the review criteria.
62
-
63
- * Make sure the Travis, Appvyor, and codecov tests are passing before
64
- merging.
66
+ * Make sure the Travis, Appvyor, circle, and codecov tests are passing
67
+ before merging.
65
68
66
69
- Whenever a pull request is created or updated, Travis and Appveyor
67
70
automatically runs the test suite on all versions of Python
68
71
supported by Matplotlib. The `tox ` support in Matplotlib may be
69
72
useful for testing locally.
70
73
71
- * Do not self merge, except for 'small' patches to un-break the CI.
74
+ * Do not self merge, except for 'small' patches to un-break the CI or
75
+ when another reviewer explicitly allows it (ex, "Approve modulo CI
76
+ passing, may self merge when green")
72
77
73
78
* Squashing is case-by-case. The balance is between burden on the
74
79
contributor, keeping a relatively clean history, and keeping a
75
80
history usable for bisecting. The only time we are really strict
76
81
about it is to eliminate binary files (ex multiple test image
77
82
re-generations) and to remove upstream merges.
78
83
79
- * Be patient with contributors.
80
-
81
84
* Do not let perfect be the enemy of the good, particularly for
82
85
documentation or example PRs. If you find yourself making many
83
- small suggestions, either open a PR against the original branch or
84
- merge the PR and then open a new PR against upstream.
86
+ small suggestions, either open a PR against the original branch,
87
+ push changes to the contributor branch, or merge the PR and then
88
+ open a new PR against upstream.
89
+
90
+
85
91
86
92
87
93
Branches and Backports
0 commit comments