@@ -12,13 +12,10 @@ Pull request checklist
12
12
Branch selection
13
13
----------------
14
14
15
- * In general, simple bugfixes that are unlikely to introduce new bugs
16
- of their own should be merged onto the maintenance branch. New
17
- features, or anything that changes the API, should be made against
18
- master. The rules are fuzzy here -- when in doubt, target master.
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.
19
18
20
- * Once changes are merged into the maintenance branch, they should
21
- be merged into master.
22
19
23
20
Documentation
24
21
-------------
@@ -87,31 +84,76 @@ PR Review guidelines
87
84
merge the PR and then open a new PR against upstream.
88
85
89
86
90
- Backports
91
- =========
87
+ Branches and Backports
88
+ ======================
92
89
93
90
94
- When doing backports please include the branch you backported the
95
- commit to along with the SHA in a comment on the original PR.
91
+ The current active branches are
96
92
97
- We do a backport from master to v2.0.x assuming:
93
+ *master *
94
+ This will be Matplotlib 3.0. Supports Python 3.5+.
98
95
99
- * ``matplotlib `` is a read-only remote branch of the matplotlib/matplotlib repo
96
+ *v2.2.x *
97
+ Maintenance branch for Matplotlib 2.2 LTS. Supports Python 2.7, 3.4+
98
+
99
+ *v2.2.N-doc *
100
+ Documentation for the current release. On a patch release, this will be replaced
101
+ by a properly named branch for the new release.
102
+
103
+
104
+ We always will backport to 2.2.x
105
+
106
+ - critical bug fixes (segfault, failure to import, things that the
107
+ user can not work around)
108
+ - fixes for regressions against 2.0 or 2.1
109
+
110
+ Everything else (regressions against 1.x versions, bugs/api
111
+ inconsistencies the user can work around in their code) are on a
112
+ case-by-case basis, should be low-risk, and need someone to advocate
113
+ for and shepherd through the backport.
114
+
115
+ The only changes to be backported to 2.2.N-doc are changes to
116
+ ``doc ``, ``examples ``, or ``tutorials ``. Any changes to
117
+ ``lib `` or ``src `` should not be backported to this branch.
118
+
119
+ Automated backports
120
+ -------------------
100
121
101
- * ``DANGER `` is a read/write remote branch of the matplotlib/matplotlib repo
122
+ We use meeseeksdev bot to automatically backport merges to the correct
123
+ maintenance branch base on the milestone. To work properly the
124
+ milestone must be set before merging. If you have commit rights, the
125
+ bot can also be manually triggered after a merge by leaving a message
126
+ ``@meeseeksdev backport to BRANCH `` on the PR. If there are conflicts
127
+ meeseekdevs will inform you that the backport needs to be done
128
+ manually.
129
+
130
+ The target branch is configured by putting ``on-merge: backport to
131
+ TARGETBRANCH `` in the milestone description on it's own line.
132
+
133
+ If the bot is not working as expected, please report issues to
134
+ `Meeseeksdev <https://github.com/MeeseeksBox/MeeseeksDev >`__.
135
+
136
+
137
+ Manual backports
138
+ ----------------
139
+
140
+ When doing backports please copy the form used by meeseekdev,
141
+ ``Backport PR #XXXX: TITLE OF PR ``. If you need to manually resolve
142
+ conflicts make note of them and how you resolved them in the commit
143
+ message.
144
+
145
+ We do a backport from master to v2.2.x assuming:
146
+
147
+ * ``matplotlib `` is a read-only remote branch of the matplotlib/matplotlib repo
102
148
103
149
The ``TARGET_SHA `` is the hash of the merge commit you would like to
104
150
backport. This can be read off of the github PR page (in the UI with
105
151
the merge notification) or through the git CLI tools.::
106
152
107
153
git fetch matplotlib
108
- git checkout v2.0 .x
109
- git merge --ff-only matplotlib/v2.0 .x
154
+ git checkout v2.2 .x
155
+ git merge --ff-only matplotlib/v2.2 .x
110
156
git cherry-pick -m 1 TARGET_SHA
111
- git log --graph --decorate # to look at it
112
- # local tests? (use your judgment)
113
- git push DANGER v2.0.x
114
- # leave a comment on PR noting sha of the resulting commit
115
- # from the cherry-pick + branch it was moved to
157
+ # resolve conflicts and commit if required
116
158
117
- These commands work on git 2.7.1 .
159
+ Use your discretion to push directly to upstream or to open a PR .
0 commit comments