<html xmlns="http://www.w3.org/1999/xhtml">

<head>

<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

<title>Reviewers guideline &mdash; Matplotlib 2.0.0 documentation</title>

<link rel="stylesheet" href="../_static/mpl.css"

type="text/css" />

<link rel="stylesheet" href="../_static/pygments.css"

type="text/css" />

<script type="text/javascript">

var DOCUMENTATION_OPTIONS = {

URL_ROOT: '../',

VERSION: '2.0.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.0.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.0.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="Making a patch" href="gitwash/patching.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.0.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>

<img style="float: right; margin-bottom: -40px; top: 0; right: 0; border: 0;" src="https://s3.amazonaws.com/github/ribbons/forkme_right_orange_ff7600.png" usemap="#ribbonmap"/>

<map name="ribbonmap">

<area shape="poly" coords="15,0,148,-1,148,135" href="https://github.com/matplotlib/matplotlib" title="Fork me on GitHub" />

<div style="background-color: white; text-align: left; padding: 10px 10px 15px 15px">

<a href="../index.html"><img src="../_static/logo2.svg" width="540px" border="0" alt="matplotlib"/></a>

<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/patching.html" title="Making a patch"

accesskey="P">previous</a> |</li>

<li><a href="../index.html">home</a>|&nbsp;</li>

<li><a href="../examples/index.html">examples</a>|&nbsp;</li>

<li><a href="../gallery.html">gallery</a>|&nbsp;</li>

<li><a href="../api/pyplot_summary.html">pyplot</a>|&nbsp;</li>

<li><a href="../contents.html">docs</a> &raquo;</li>

<li><a href="index.html" accesskey="U">The Matplotlib Developers&#8217; Guide</a> &raquo;</li>

</ul>

</div>

<div class="sphinxsidebar">

<div class="sphinxsidebarwrapper">

<a href="http://depsy.org/package/python/matplotlib">

<img src="http://depsy.org/api/package/pypi/matplotlib/badge.svg">

Travis-CI: <a href="https://travis-ci.org/matplotlib/matplotlib">

<img src="https://travis-ci.org/matplotlib/matplotlib.svg?branch=master"/>

<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>

<li><a class="reference internal" href="#pr-review-guidelines">PR Review guidelines</a></li>

<li><a class="reference internal" href="#backports">Backports</a></li>

<div class="relations">

<h3>Related Topics</h3>

<li><a href="../contents.html">Documentation overview</a><ul>

<li><a href="index.html">The Matplotlib Developers&#8217; Guide</a><ul>

<li>Previous: <a href="gitwash/patching.html" title="previous chapter">Making a patch</a></li>

<li>Next: <a href="release_guide.html" title="next chapter">Release Guide</a></li>

</ul></li>

</ul></li>

<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>

<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 &#8211; when in doubt, target master.</li>

<li>Once changes are merged into the maintenance branch, they should

be merged into master.</li>

<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&#8217;s a new module, don&#8217;t

forget to add a new rst file to the API docs.</li>

<li>Each high-level plotting function should have a simple 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> tree.</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&#8217;s tips for documenting matplotlib</span></a> for our documentation style guide.</li>

<li>If your changes are non-trivial, please make an entry in the

<code class="file docutils literal"><span class="pre">CHANGELOG</span></code>.</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>

<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 class="simple">

<li>If you have a commit bit, then you are trusted to use it. Please

help review and merge PRs!</li>

<li>Two developers (those with commit rights) should review all pull

requests. If you are the first to review a PR please and approve of

the changes please edit the title to include <code class="docutils literal"><span class="pre">'[MRG+1]'</span></code> and use

the github <a class="reference external" href="https://help.github.com/articles/reviewing-changes-in-pull-requests/">&#8216;approve review&#8217;</a>

tool to mark it as such. If you are a subsequent reviewer and you

approve either merge (and backport if needed) or increment the

number in the title to ask for further review (and trigger the gh

&#8216;approve review&#8217;). If you do the merge please removed the

<code class="docutils literal"><span class="pre">'[MRG+N']</span></code> prefix.</li>

<li>Make sure the Travis tests are passing before merging.<ul>

<li>The Travis tests automatically test on all of the Python versions

Matplotlib supports whenever a pull request is created or updated.

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>

<li>Do not self merge, except for &#8216;small&#8217; patches to un-break the CI.</li>

<li>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.</li>

<li>Be patient with new contributors.</li>

<li>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.</li>

<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>Assuming we have <code class="docutils literal"><span class="pre">matplotlib</span></code> as a read-only remote to the

matplotlib/matplotlib repo and <code class="docutils literal"><span class="pre">DANGER</span></code> as a read/write remote to

the matplotlib/matplotlib repo, we do a backport from master to 2.x.

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="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="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">gitk</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="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>

<p>These commands work on git 2.7.1.</p>

</div>

</div>

</div>

<div class="clearer"></div>

</div>

<div class="footer">

&copy; Copyright 2002 - 2012 John Hunter, Darren Dale, Eric Firing, Michael Droettboom and the Matplotlib development team; 2012 - 2016 The Matplotlib development team.

Last updated on Feb 20, 2017.

Created using <a

href="http://sphinx-doc.org/">Sphinx</a> 1.5.2.

</div>