Skip to content
Navigation Menu
{{ message }}
-
Notifications
You must be signed in to change notification settings - Fork 62
Expand file tree
/
Copy pathcoding_guide.html
More file actions
275 lines (249 loc) · 13.7 KB
/
Copy pathcoding_guide.html
File metadata and controls
275 lines (249 loc) · 13.7 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Reviewers guideline — Matplotlib 2.1.0 documentation</title>
<link rel="stylesheet" href="../_static/mpl.css"
type="text/css" />
<link rel="stylesheet" href="../_static/pygments.css"
type="text/css" />
<link rel="stylesheet" href="../_static/gallery.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../',
VERSION: '2.1.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</script>
<script type="text/javascript" src="../_static/jquery.js"></script>
<script type="text/javascript" src="../_static/underscore.js"></script>
<script type="text/javascript" src="../_static/doctools.js"></script>
<link rel="search" type="application/opensearchdescription+xml"
title="Search within Matplotlib 2.1.0 documentation"
href="../_static/opensearch.xml"/>
<link rel="shortcut icon" href="../_static/favicon.ico"/>
<link rel="index" title="Index" href="../genindex.html"
/>
<link rel="search" title="Search" href="../search.html"
/>
<link rel="top" title="Matplotlib 2.1.0 documentation" href="../index.html" />
<link rel="up" title="The Matplotlib Developers’ Guide" href="index.html" />
<link rel="next" title="Release Guide" href="release_guide.html" />
<link rel="prev" title="Two and three dots in difference specs" href="gitwash/dot2_dot3.html" />
<link rel="canonical" href="https://matplotlib.org/stable/devel/coding_guide.html" />
<script data-domain="matplotlib.org" defer="defer" src="https://views.scientific-python.org/js/script.js"></script>
</head>
<body>
<div id="unreleased-message"> You are reading an old version of the documentation (v2.1.0). For the latest version see <a href="https://matplotlib.org/stable/devel/coding_guide.html">https://matplotlib.org/stable/devel/coding_guide.html</a></div>
<div style="background-color: white; text-align: left; padding: 10px 10px 15px 15px; position: relative;">
<a href="../index.html"><img src="../_static/logo2.svg" width="540px" border="0" alt="matplotlib"/></a>
<!-- The "Fork me on github" ribbon -->
<div id="forkongithub"><a href="https://github.com/matplotlib/matplotlib">Fork me on GitHub</a></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="../py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="release_guide.html" title="Release Guide"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="gitwash/dot2_dot3.html" title="Two and three dots in difference specs"
accesskey="P">previous</a> |</li>
<li><a href="../index.html">home</a>| </li>
<li><a href="../gallery/index.html">examples</a>| </li>
<li><a href="../tutorials/index.html">tutorials</a>| </li>
<li><a href="../api/pyplot_summary.html">pyplot</a>| </li>
<li><a href="../contents.html">docs</a> »</li>
<li><a href="index.html" accesskey="U">The Matplotlib Developers’ Guide</a> »</li>
</ul>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper"><a href="https://www.numfocus.org">
<image src="https://img.shields.io/badge/powered%20by-NumFOCUS-orange.svg?style=flat&colorA=E1523D&colorB=007D8A">
</a>
<br/>
<a href="http://depsy.org/package/python/matplotlib">
<img src="../_static/depsy_badge.svg">
</a>
<br/>
Travis-CI: <a href="https://travis-ci.org/matplotlib/matplotlib">
<img src="https://travis-ci.org/matplotlib/matplotlib.svg?branch=master"/>
</a>
<br/>
<h3><a href="../contents.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Reviewers guideline</a><ul>
<li><a class="reference internal" href="#pull-request-checklist">Pull request checklist</a><ul>
<li><a class="reference internal" href="#branch-selection">Branch selection</a></li>
<li><a class="reference internal" href="#documentation">Documentation</a></li>
</ul>
</li>
<li><a class="reference internal" href="#pr-review-guidelines">PR Review guidelines</a></li>
<li><a class="reference internal" href="#backports">Backports</a></li>
</ul>
</li>
</ul>
<div class="relations">
<h3>Related Topics</h3>
<ul>
<li><a href="../contents.html">Documentation overview</a><ul>
<li><a href="index.html">The Matplotlib Developers’ Guide</a><ul>
<li>Previous: <a href="gitwash/dot2_dot3.html" title="previous chapter">Two and three dots in difference specs</a></li>
<li>Next: <a href="release_guide.html" title="next chapter">Release Guide</a></li>
</ul></li>
</ul></li>
</ul>
</div>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../_sources/devel/coding_guide.rst.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="../search.html" method="get">
<div><input type="text" name="q" /></div>
<div><input type="submit" value="Go" /></div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="reviewers-guideline">
<span id="reviewers-guide"></span><h1>Reviewers guideline<a class="headerlink" href="#reviewers-guideline" title="Permalink to this headline">¶</a></h1>
<div class="section" id="pull-request-checklist">
<span id="id1"></span><h2>Pull request checklist<a class="headerlink" href="#pull-request-checklist" title="Permalink to this headline">¶</a></h2>
<div class="section" id="branch-selection">
<h3>Branch selection<a class="headerlink" href="#branch-selection" title="Permalink to this headline">¶</a></h3>
<ul class="simple">
<li>In general, simple bugfixes that are unlikely to introduce new bugs
of their own should be merged onto the maintenance branch. New
features, or anything that changes the API, should be made against
master. The rules are fuzzy here – when in doubt, target master.</li>
<li>Once changes are merged into the maintenance branch, they should
be merged into master.</li>
</ul>
</div>
<div class="section" id="documentation">
<h3>Documentation<a class="headerlink" href="#documentation" title="Permalink to this headline">¶</a></h3>
<ul class="simple">
<li>Every new feature should be documented. If it’s a new module, don’t
forget to add a new rst file to the API docs.</li>
<li>Each high-level plotting function should have a small example in
the <code class="xref py py-obj docutils literal"><span class="pre">Example</span></code> section of the docstring. This should be as simple as
possible to demonstrate the method. More complex examples should go
in the <code class="xref py py-obj docutils literal"><span class="pre">examples</span></code> section of the documentation.</li>
<li>Build the docs and make sure all formatting warnings are addressed.</li>
<li>See <a class="reference internal" href="documenting_mpl.html#documenting-matplotlib"><span class="std std-ref">Developer’s tips for documenting matplotlib</span></a> for our documentation style guide.</li>
<li>If your change is a major new feature, add an entry to
<code class="file docutils literal"><span class="pre">doc/users/whats_new.rst</span></code>.</li>
<li>If you change the API in a backward-incompatible way, please
document it in <code class="file docutils literal"><span class="pre">doc/api/api_changes.rst</span></code>.</li>
</ul>
</div>
</div>
<div class="section" id="pr-review-guidelines">
<h2>PR Review guidelines<a class="headerlink" href="#pr-review-guidelines" title="Permalink to this headline">¶</a></h2>
<ul>
<li><p class="first">If you have commit rights, then you are trusted to use them. Please
help review and merge PRs!</p>
</li>
<li><p class="first">For code changes (anything in <code class="docutils literal"><span class="pre">src</span></code> or <code class="docutils literal"><span class="pre">lib</span></code>) 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 <a class="reference external" href="https://help.github.com/articles/reviewing-changes-in-pull-requests/">‘approve review’</a>
tool to mark it as such. If you are a subsequent reviewer and you
approve, either merge (and backport if needed) or select <code class="docutils literal"><span class="pre">'approve</span>
<span class="pre">review'</span></code>.</p>
<p>Ensure that all API changes are documented in
<code class="file docutils literal"><span class="pre">doc/api/api_changes</span></code> and significant new features have and
entry in <code class="file docutils literal"><span class="pre">doc/user/whats_new</span></code>.</p>
</li>
<li><p class="first">Documentation and examples may be merged by the first reviewer. Use
the threshold “is this better than it was?” as the review criteria.</p>
</li>
<li><p class="first">Make sure the Travis, Appvyor, and codecov tests are passing before
merging.</p>
<ul class="simple">
<li>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 <code class="xref py py-obj docutils literal"><span class="pre">tox</span></code> support in Matplotlib may be
useful for testing locally.</li>
</ul>
</li>
<li><p class="first">Do not self merge, except for ‘small’ patches to un-break the CI.</p>
</li>
<li><p class="first">Squashing is case-by-case. The balance is between burden on the
contributor, keeping a relatively clean history, and keeping a
history usable for bisecting. The only time we are really strict
about it is to eliminate binary files (ex multiple test image
re-generations) and to remove upstream merges.</p>
</li>
<li><p class="first">Be patient with contributors.</p>
</li>
<li><p class="first">Do not let perfect be the enemy of the good, particularly for
documentation or example PRs. If you find yourself making many
small suggestions, either open a PR against the original branch or
merge the PR and then open a new PR against upstream.</p>
</li>
</ul>
</div>
<div class="section" id="backports">
<h2>Backports<a class="headerlink" href="#backports" title="Permalink to this headline">¶</a></h2>
<p>When doing backports please include the branch you backported the
commit to along with the SHA in a comment on the original PR.</p>
<p>We do a backport from master to v2.0.x assuming:</p>
<ul class="simple">
<li><code class="docutils literal"><span class="pre">matplotlib</span></code> is a read-only remote branch of the matplotlib/matplotlib repo</li>
<li><code class="docutils literal"><span class="pre">DANGER</span></code> is a read/write remote branch of the matplotlib/matplotlib repo</li>
</ul>
<p>The <code class="docutils literal"><span class="pre">TARGET_SHA</span></code> is the hash of the merge commit you would like to
backport. This can be read off of the github PR page (in the UI with
the merge notification) or through the git CLI tools.:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="n">git</span> <span class="n">fetch</span> <span class="n">matplotlib</span>
<span class="n">git</span> <span class="n">checkout</span> <span class="n">v2</span><span class="o">.</span><span class="mf">0.</span><span class="n">x</span>
<span class="n">git</span> <span class="n">merge</span> <span class="o">--</span><span class="n">ff</span><span class="o">-</span><span class="n">only</span> <span class="n">matplotlib</span><span class="o">/</span><span class="n">v2</span><span class="o">.</span><span class="mf">0.</span><span class="n">x</span>
<span class="n">git</span> <span class="n">cherry</span><span class="o">-</span><span class="n">pick</span> <span class="o">-</span><span class="n">m</span> <span class="mi">1</span> <span class="n">TARGET_SHA</span>
<span class="n">git</span> <span class="n">log</span> <span class="o">--</span><span class="n">graph</span> <span class="o">--</span><span class="n">decorate</span> <span class="c1"># to look at it</span>
<span class="c1"># local tests? (use your judgment)</span>
<span class="n">git</span> <span class="n">push</span> <span class="n">DANGER</span> <span class="n">v2</span><span class="o">.</span><span class="mf">0.</span><span class="n">x</span>
<span class="c1"># leave a comment on PR noting sha of the resulting commit</span>
<span class="c1"># from the cherry-pick + branch it was moved to</span>
</pre></div>
</div>
<p>These commands work on git 2.7.1.</p>
</div>
</div>
</div>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="footer">
© Copyright 2002 - 2012 John Hunter, Darren Dale, Eric Firing, Michael Droettboom and the Matplotlib development team; 2012 - 2017 The Matplotlib development team.
Last updated on Oct 13, 2017.
Created using <a
href="http://sphinx-doc.org/">Sphinx</a> 1.6.3.
</div>
</body>
<footer>
</footer>
</html>
You can’t perform that action at this time.