Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 668f260

Browse files
committed
DOC: tweak reviewer guidelines.
- include link to Brett Cannon talk - re-order bullet points
1 parent 5d3bb78 commit 668f260

File tree

1 file changed

+21
-15
lines changed

1 file changed

+21
-15
lines changed

doc/devel/coding_guide.rst

Lines changed: 21 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -41,47 +41,53 @@ Documentation
4141
PR Review guidelines
4242
====================
4343

44+
* Be patient and `kind <https://youtu.be/tzFWz5fiVKU?t=49m30s>`__ with
45+
contributors.
46+
4447
* If you have commit rights, then you are trusted to use them. Please
4548
help review and merge PRs!
4649

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'
5157
<https://help.github.com/articles/reviewing-changes-in-pull-requests/>`__
5258
tool to mark it as such. If you are a subsequent reviewer and you
5359
approve, either merge (and backport if needed) or select ``'approve
54-
review'``.
60+
review'`` if you think further review is required.
5561

5662
Ensure that all API changes are documented in
5763
:file:`doc/api/api_changes` and significant new features have and
5864
entry in :file:`doc/user/whats_new`.
5965

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.
6568

6669
- Whenever a pull request is created or updated, Travis and Appveyor
6770
automatically runs the test suite on all versions of Python
6871
supported by Matplotlib. The `tox` support in Matplotlib may be
6972
useful for testing locally.
7073

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")
7277

7378
* Squashing is case-by-case. The balance is between burden on the
7479
contributor, keeping a relatively clean history, and keeping a
7580
history usable for bisecting. The only time we are really strict
7681
about it is to eliminate binary files (ex multiple test image
7782
re-generations) and to remove upstream merges.
7883

79-
* Be patient with contributors.
80-
8184
* Do not let perfect be the enemy of the good, particularly for
8285
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+
8591

8692

8793
Branches and Backports

0 commit comments

Comments
 (0)