summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNelle Varoquaux <nelle.varoquaux@gmail.com>2017-07-16 08:58:23 -0700
committerGitHub <noreply@github.com>2017-07-16 08:58:23 -0700
commit9dd0db61a7706844603ca7653856a13022f65541 (patch)
tree32bb01ffffedc5db6f8beb8efa35c57fa0304693
parent380670bb9bc220c697d1da64fe9233842531ec93 (diff)
parentb01086255ef9b4826895f63404adea769396ee21 (diff)
Merge pull request #8889 from tacaswell/doc_doc_review
DOC: updated review guidelines
-rw-r--r--doc/devel/coding_guide.rst32
1 files changed, 20 insertions, 12 deletions
diff --git a/doc/devel/coding_guide.rst b/doc/devel/coding_guide.rst
index 3065bffe8..15cdac438 100644
--- a/doc/devel/coding_guide.rst
+++ b/doc/devel/coding_guide.rst
@@ -47,21 +47,29 @@ PR Review guidelines
* If you have commit rights, then you are trusted to use them. Please
help review and merge PRs!
-* Two developers (those with commit rights) should review all pull
- requests. If you are the first to review a PR and approve of
- the changes, please edit the title to include ``'[MRG+1]'`` and use
- the github `'approve review'
+* For code changes (anything in ``src`` or ``lib``) two developers
+ (those with commit rights) should review all pull requests. If you
+ are the first to review a PR and approve of the changes use the
+ github `'approve review'
<https://help.github.com/articles/reviewing-changes-in-pull-requests/>`__
tool to mark it as such. If you are a subsequent reviewer and you
- approve, either merge (and backport if needed) or select ``'approve review'`` and
- increment the number in the title to ask for further review.
- If you do the merge, please remove the ``'[MRG+N']`` prefix.
+ approve, either merge (and backport if needed) or select ``'approve
+ review'``.
-* Make sure the Travis tests are passing before merging.
+ Ensure that all API changes are documented in
+ :file:`doc/api/api_changes` and significant new features have and
+ entry in :file:`doc/user/whats_new`.
- - Whenever a pull request is created or updated, Travis automatically runs
- the test suite on all versions of Python supported by Matplotlib.
- The `tox` support in Matplotlib may be useful for testing locally.
+* Documentation and examples may be merged by the first reviewer. Use
+ the threshold "is this better than it was?" as the review criteria.
+
+* Make sure the Travis, Appvyor, and codecov tests are passing before
+ merging.
+
+ - Whenever a pull request is created or updated, Travis and Appveyor
+ automatically runs the test suite on all versions of Python
+ supported by Matplotlib. The `tox` support in Matplotlib may be
+ useful for testing locally.
* Do not self merge, except for 'small' patches to un-break the CI.
@@ -88,7 +96,7 @@ commit to along with the SHA in a comment on the original PR.
We do a backport from master to v2.0.x assuming:
-* ``matplotlib`` is a read-only remote branch of the matplotlib/matplotlib repo
+* ``matplotlib`` is a read-only remote branch of the matplotlib/matplotlib repo
* ``DANGER`` is a read/write remote branch of the matplotlib/matplotlib repo
generated by cgit on debian on lair
contact matthew@masot.net with questions or feedback