Skip to content

Commit 9dd0db6

Browse files
authored
Merge pull request #8889 from tacaswell/doc_doc_review
DOC: updated review guidelines
2 parents 380670b + b010862 commit 9dd0db6

File tree

1 file changed

+20
-12
lines changed

1 file changed

+20
-12
lines changed

doc/devel/coding_guide.rst

+20-12
Original file line numberDiff line numberDiff line change
@@ -47,21 +47,29 @@ PR Review guidelines
4747
* If you have commit rights, then you are trusted to use them. Please
4848
help review and merge PRs!
4949

50-
* Two developers (those with commit rights) should review all pull
51-
requests. If you are the first to review a PR and approve of
52-
the changes, please edit the title to include ``'[MRG+1]'`` and use
53-
the github `'approve review'
50+
* For code changes (anything in ``src`` or ``lib``) two developers
51+
(those with commit rights) should review all pull requests. If you
52+
are the first to review a PR and approve of the changes use the
53+
github `'approve review'
5454
<https://help.github.com/articles/reviewing-changes-in-pull-requests/>`__
5555
tool to mark it as such. If you are a subsequent reviewer and you
56-
approve, either merge (and backport if needed) or select ``'approve review'`` and
57-
increment the number in the title to ask for further review.
58-
If you do the merge, please remove the ``'[MRG+N']`` prefix.
56+
approve, either merge (and backport if needed) or select ``'approve
57+
review'``.
5958

60-
* Make sure the Travis tests are passing before merging.
59+
Ensure that all API changes are documented in
60+
:file:`doc/api/api_changes` and significant new features have and
61+
entry in :file:`doc/user/whats_new`.
6162

62-
- Whenever a pull request is created or updated, Travis automatically runs
63-
the test suite on all versions of Python supported by Matplotlib.
64-
The `tox` support in Matplotlib may be useful for testing locally.
63+
* Documentation and examples may be merged by the first reviewer. Use
64+
the threshold "is this better than it was?" as the review criteria.
65+
66+
* Make sure the Travis, Appvyor, and codecov tests are passing before
67+
merging.
68+
69+
- Whenever a pull request is created or updated, Travis and Appveyor
70+
automatically runs the test suite on all versions of Python
71+
supported by Matplotlib. The `tox` support in Matplotlib may be
72+
useful for testing locally.
6573

6674
* Do not self merge, except for 'small' patches to un-break the CI.
6775

@@ -88,7 +96,7 @@ commit to along with the SHA in a comment on the original PR.
8896

8997
We do a backport from master to v2.0.x assuming:
9098

91-
* ``matplotlib`` is a read-only remote branch of the matplotlib/matplotlib repo
99+
* ``matplotlib`` is a read-only remote branch of the matplotlib/matplotlib repo
92100

93101
* ``DANGER`` is a read/write remote branch of the matplotlib/matplotlib repo
94102

0 commit comments

Comments
 (0)