<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->

<meta charset="utf-8">

<meta name="viewport" content="width=device-width, initial-scale=1.0">

<title>Contributing &mdash; probscale 0.2.3 documentation</title>

<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />

<link rel="top" title="probscale 0.2.3 documentation" href="index.html"/>

<script src="_static/js/modernizr.min.js"></script>

<body class="wy-body-for-nav" role="document">

<div class="wy-grid-for-nav">

<nav data-toggle="wy-nav-shift" class="wy-nav-side">

<div class="wy-side-scroll">

<div class="wy-side-nav-search">

<a href="index.html" class="icon icon-home"> probscale

</a>

<div class="version">

0.2.3

</div>

<div role="search">

<form id="rtd-search-form" class="wy-form" action="search.html" method="get">

<input type="text" name="q" placeholder="Search docs" />

<input type="hidden" name="check_keywords" value="yes" />

<input type="hidden" name="area" value="default" />

</form>

</div>

<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">

<ul>

<li class="toctree-l1"><a class="reference internal" href="tutorial/getting_started.html">Getting started with <code class="docutils literal"><span class="pre">mpl-probscale</span></code></a></li>

<li class="toctree-l1"><a class="reference internal" href="tutorial/closer_look_at_viz.html">A closer look at probability plots</a></li>

<li class="toctree-l1"><a class="reference internal" href="tutorial/closer_look_at_plot_pos.html">Using different formulations of plotting positions</a></li>

<li class="toctree-l1"><a class="reference internal" href="api.html">API and Source Reference</a></li>

</div>

</div>

</nav>

<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">

<nav class="wy-nav-top" role="navigation" aria-label="top navigation">

<i data-toggle="wy-nav-top" class="fa fa-bars"></i>

<a href="index.html">probscale</a>

</nav>

<div class="wy-nav-content">

<div class="rst-content">

<div role="navigation" aria-label="breadcrumbs navigation">

<ul class="wy-breadcrumbs">

<li><a href="index.html">Docs</a> &raquo;</li>

<li>Contributing</li>

<li class="wy-breadcrumbs-aside">

<a href="_sources/contributing.txt" rel="nofollow"> View page source</a>

</li>

</ul>

<hr/>

<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">

<div itemprop="articleBody">

<div class="section" id="contributing">

<h1>Contributing<a class="headerlink" href="#contributing" title="Permalink to this headline">¶</a></h1>

<p>Contributions are welcome, and they are greatly appreciated! Every

little bit helps, and credit will always be given.</p>

<p>You can contribute in many ways:</p>

<div class="section" id="types-of-contributions">

<h2>Types of Contributions<a class="headerlink" href="#types-of-contributions" title="Permalink to this headline">¶</a></h2>

<div class="section" id="report-bugs">

<h3>Report Bugs<a class="headerlink" href="#report-bugs" title="Permalink to this headline">¶</a></h3>

<p>Report bugs at <a class="reference external" href="https://github.com/matplotlib/mpl-probscale/issues">https://github.com/matplotlib/mpl-probscale/issues</a>.</p>

<p>If you are reporting a bug, please include:</p>

<ul class="simple">

<li>Your operating system name and version.</li>

<li>Any details about your local setup that might be helpful in troubleshooting.</li>

<li>Detailed steps to reproduce the bug.</li>

<div class="section" id="fix-bugs">

<h3>Fix Bugs<a class="headerlink" href="#fix-bugs" title="Permalink to this headline">¶</a></h3>

<p>Look through the GitHub issues for bugs. Anything tagged with &#8220;bug&#8221;

and &#8220;help wanted&#8221; is open to whoever wants to implement it.</p>

<div class="section" id="implement-features">

<h3>Implement Features<a class="headerlink" href="#implement-features" title="Permalink to this headline">¶</a></h3>

<p>Look through the GitHub issues for features. Anything tagged with &#8220;enhancement&#8221;

and &#8220;help wanted&#8221; is open to whoever wants to implement it.</p>

<div class="section" id="write-documentation">

<h3>Write Documentation<a class="headerlink" href="#write-documentation" title="Permalink to this headline">¶</a></h3>

<p>mpl-probscale could always use more documentation, whether as part of the

official mpl-probscale docs, in docstrings, or even on the web in blog posts,

articles, and such.</p>

<div class="section" id="submit-feedback">

<h3>Submit Feedback<a class="headerlink" href="#submit-feedback" title="Permalink to this headline">¶</a></h3>

<p>The best way to send feedback is to file an issue at <a class="reference external" href="https://github.com/matplotlib/mpl-probscale/issues">https://github.com/matplotlib/mpl-probscale/issues</a>.</p>

<p>If you are proposing a feature:</p>

<ul class="simple">

<li>Explain in detail how it would work.</li>

<li>Keep the scope as narrow as possible, to make it easier to implement.</li>

<li>Remember that this is a volunteer-driven project, and that contributions

are welcome :)</li>

<div class="section" id="get-started">

<h2>Get Started!<a class="headerlink" href="#get-started" title="Permalink to this headline">¶</a></h2>

<p>Ready to contribute? Here&#8217;s how to set up <cite>probscale</cite> for local development.</p>

<ol class="arabic">

<li><p class="first">Fork the <cite>probscale</cite> repo on GitHub.</p>

<li><p class="first">Clone your fork locally:</p>

<div class="highlight-shell"><div class="highlight"><pre><span></span>$ git clone git@github.com:your_name_here/probscale.git

<li><p class="first">Install your local copy into a conda environment. Assuming you have conda installed, this is how you set up your fork for local development:</p>

<div class="highlight-shell"><div class="highlight"><pre><span></span>$ conda config --add channels conda-forge

$ conda create --name<span class="o">=</span>probscale <span class="nv">python</span><span class="o">=</span>3.5 numpy matplotlib pytest pytest-cov pytest-pep8 pytest-mpl

$ <span class="nb">cd</span> probscale/

$ pip install -e .

<li><p class="first">Create a branch for local development:</p>

<div class="highlight-shell"><div class="highlight"><pre><span></span>$ git checkout -b name-of-your-bugfix-or-feature

<p>Now you can make your changes locally.</p>

<li><p class="first">When you&#8217;re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:</p>

<div class="highlight-shell"><div class="highlight"><pre><span></span>$ python check_probscale.py --mpl --pep8 --cov

<li><p class="first">Commit your changes and push your branch to GitHub:</p>

<div class="highlight-shell"><div class="highlight"><pre><span></span>$ git add &lt;files you want to stage&gt;

$ git commit -m <span class="s2">&quot;Your detailed description of your changes.&quot;</span>

$ git push origin name-of-your-bugfix-or-feature

<li><p class="first">Submit a pull request through the GitHub website.</p>

<p>Matplotlib has good info on working with <a class="reference external" href="http://matplotlib.org/devel/coding_guide.html`">source code</a> using <a class="reference external" href="http://matplotlib.org/devel/gitwash/development_workflow.html">git and GitHub</a>.</p>

<div class="section" id="pull-request-guidelines">

<h2>Pull Request Guidelines<a class="headerlink" href="#pull-request-guidelines" title="Permalink to this headline">¶</a></h2>

<p>Before you submit a pull request, check that it meets these guidelines:</p>

<ol class="arabic simple">

<li>The pull request should include tests.</li>

<li>If the pull request adds functionality, the docs should be updated. Put

your new functionality into a function with a docstring, and add the

feature to the list in README.rst.</li>

<li>The pull request should work for Python 3.4 and higher. Check

<a class="reference external" href="https://travis-ci.org/matplotlib/mpl-probscale/pull_requests">https://travis-ci.org/matplotlib/mpl-probscale/pull_requests</a>

and make sure that the tests pass for all supported Python versions.</li>

<div class="section" id="tips">

<h2>Tips<a class="headerlink" href="#tips" title="Permalink to this headline">¶</a></h2>

<p>To run a subset of tests:</p>

<div class="highlight-shell"><div class="highlight"><pre><span></span>$ py.test tests.test_probscale

<div class="section" id="configuring-sublime-text-3-to-run-the-tests">

<h3>Configuring Sublime Text 3 to run the tests<a class="headerlink" href="#configuring-sublime-text-3-to-run-the-tests" title="Permalink to this headline">¶</a></h3>

<p>In Sublime, got to Tools -&gt; Build System -&gt; New Build System.

Then add the following configuration and save as &#8220;probscale.sublime-build&#8221;:</p>

<div class="highlight-shell"><div class="highlight"><pre><span></span><span class="o">{</span>

<span class="s2">&quot;working_dir&quot;</span>: <span class="s2">&quot;&lt;path to the git repository&gt;&quot;</span>,

<span class="s2">&quot;cmd&quot;</span>: <span class="s2">&quot;&lt;full path of the python executable&gt; check_probscale.py --verbose &lt;other pytest options&gt;&quot;</span>,

<span class="o">}</span>

<div class="section" id="configuring-atom-to-run-the-tests">

<h3>Configuring Atom to run the tests<a class="headerlink" href="#configuring-atom-to-run-the-tests" title="Permalink to this headline">¶</a></h3>

<p>In Atom, install the <a class="reference external" href="https://atom.io/packages/build">build</a> package, create a new file called &#8221;.atom-build.yml&#8221; in the

top level of the project directory, and add the following contents:</p>

<div class="highlight-shell"><div class="highlight"><pre><span></span>cmd: <span class="s2">&quot;&lt;full path of the python executable&gt;&quot;</span>

name: <span class="s2">&quot;probscale&quot;</span>

args:

- check_probscale.py

- --verbose

- &lt;other pytest options ...&gt;

cwd: &lt;path to the git repository&gt;

sh: <span class="nb">false</span>

keymap: ctrl-b

atomCommandName: namespace:testprobscale

<p>After this, hitting ctrl+b in either text editor will run the test suite.</p>

</div>

</div>

<footer>

<hr/>

<div role="contentinfo">

<p>

&copy; Copyright 2015, Paul Hobson (Geosyntec Consultants).

</p>

</div>

Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.

</div>

</div>

</section>

</div>

<script type="text/javascript">

var DOCUMENTATION_OPTIONS = {

URL_ROOT:'./',

VERSION:'0.2.3',

COLLAPSE_INDEX:false,

FILE_SUFFIX:'.html',

HAS_SOURCE: true

};

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

<script type="text/javascript" src="https://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>

<script type="text/javascript" src="_static/js/theme.js"></script>

<script type="text/javascript">

jQuery(function () {

SphinxRtdTheme.StickyNav.enable();

});

</script>