@@ -12,10 +12,9 @@ Pull request checklist
1212Branch selection
1313----------------
1414
15- In general target the master branch for all new features and
16- bug-fixes. PRs may target maintenance or doc branches on
17- a case-by-case basis.
18-
15+ Generally, all pull requests (*PRs *) should target the master branch. Other
16+ branches are fed through automatic or manual backports. Directly targeting
17+ other branches is only rarely necessary for special maintenance work.
1918
2019Documentation
2120-------------
@@ -24,9 +23,10 @@ Documentation
2423 forget to add a new rst file to the API docs.
2524
2625* Each high-level plotting function should have a small example in
27- the `Example ` section of the docstring. This should be as simple as
28- possible to demonstrate the method. More complex examples should go
29- in the `examples ` section of the documentation.
26+ the ``Examples `` section of the docstring. This should be as simple as
27+ possible to demonstrate the method. More complex examples should go into
28+ a dedicated example file in the :file: `examples ` directory, which will be
29+ rendered to the examples gallery in the documentation.
3030
3131* Build the docs and make sure all formatting warnings are addressed.
3232
@@ -47,6 +47,26 @@ 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+ * If you have the rights to set labels, tag the PR with descriptive labels.
51+ See the `list of labels <https://github.com/matplotlib/matplotlib/labels >`__.
52+
53+ * Set the milestone according to these rules:
54+
55+ * *New features and API changes * are milestoned for the next point-release
56+ ``v3.X.0 ``.
57+
58+ * *Bugfixes and docstring changes * are milestoned for the next bugfix
59+ release ``v3.X.Y ``
60+
61+ * *Documentation changes * (all .rst files and examples) are milestoned
62+ ``v3.X-doc ``
63+
64+ If multiple rules apply, choose the first matching from the above list.
65+
66+ All of these PRs should target the master branch. The milestone tag triggers
67+ an :ref: `automatic backport <automated-backports >` for milestones which have
68+ a corresponding branch.
69+
5070* Documentation and examples may be merged by the first reviewer. Use
5171 the threshold "is this better than it was?" as the review criteria.
5272
@@ -138,6 +158,8 @@ The only changes to be backported to 2.2.N-doc are changes to
138158``doc ``, ``examples ``, or ``tutorials ``. Any changes to
139159``lib `` or ``src `` should not be backported to this branch.
140160
161+ .. _automated-backports :
162+
141163Automated backports
142164-------------------
143165
0 commit comments