https://github.com/alkaline-ml/pmdarima
Tip revision: 393452c8942bb1b5e4731901bec4ca2488d42d1a authored by tgsmith61591 on 23 February 2024, 02:51:07 UTC
[ci skip] Publishing updated documentation for 'master' branch
[ci skip] Publishing updated documentation for 'master' branch
Tip revision: 393452c
contributing.html
<!DOCTYPE html>
<html class="writer-html4" lang="en" >
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>11. Contributing to pmdarima — pmdarima 2.0.4 documentation</title>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="_static/gallery.css" type="text/css" />
<link rel="stylesheet" href="_static/css/fields.css" type="text/css" />
<link rel="stylesheet" href="_static/css/gitcontrib.css" type="text/css" />
<link rel="shortcut icon" href="_static/favicon.ico"/>
<!--[if lt IE 9]>
<script src="_static/js/html5shiv.min.js"></script>
<![endif]-->
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'2.0.4',
LANGUAGE:'None',
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>
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.1/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<link rel="author" title="About these documents" href="about.html" />
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="12. Contributors" href="contributors.html" />
<link rel="prev" title="10.2. An end-to-end time series analysis" href="usecases/sun-spots.html" />
</head>
<body class="wy-body-for-nav">
<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" alt="Documentation Home"> pmdarima
</a>
<div class="version">
2.0.4
</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>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="modules/classes.html">API Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="auto_examples/index.html">Examples</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="user_guide.html">User Guide</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="about.html">1. About the project</a></li>
<li class="toctree-l2"><a class="reference internal" href="setup.html">2. Setup</a></li>
<li class="toctree-l2"><a class="reference internal" href="quickstart.html">3. Quickstart</a></li>
<li class="toctree-l2"><a class="reference internal" href="serialization.html">4. Serializing your ARIMA models</a></li>
<li class="toctree-l2"><a class="reference internal" href="refreshing.html">5. Refreshing your ARIMA models</a></li>
<li class="toctree-l2"><a class="reference internal" href="tips_and_tricks.html">6. Tips to using <code class="docutils literal notranslate"><span class="pre">auto_arima</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="no-successful-model.html">7. When no viable models can be found</a></li>
<li class="toctree-l2"><a class="reference internal" href="seasonal-differencing-issues.html">8. Encountering issues in seasonal differencing</a></li>
<li class="toctree-l2"><a class="reference internal" href="modules/datasets.html">9. Toy time-series datasets</a></li>
<li class="toctree-l2"><a class="reference internal" href="usecases.html">10. Use cases</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">11. Contributing to pmdarima</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#how-to-contribute">11.1. How to contribute</a></li>
<li class="toctree-l3"><a class="reference internal" href="#pull-request-checklist">11.2. Pull Request Checklist</a></li>
<li class="toctree-l3"><a class="reference internal" href="#filing-a-bug">11.3. Filing a bug</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="contributors.html">12. Contributors</a></li>
<li class="toctree-l2"><a class="reference internal" href="citing.html">13. Citing</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="whats_new.html">What's New?</a></li>
<li class="toctree-l1"><a class="reference internal" href="rfc/index.html">RFCs</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">pmdarima</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" class="icon icon-home"></a> »</li>
<li><a href="user_guide.html">User Guide</a> »</li>
<li>11. Contributing to pmdarima</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/contributing.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="contributing-to-pmdarima">
<span id="contrib"></span><h1>11. Contributing to pmdarima<a class="headerlink" href="#contributing-to-pmdarima" title="Permalink to this headline">¶</a></h1>
<p><strong>Note: This document is a ‘getting started’ summary for contributing code,
documentation, testing, and filing issues.</strong> Please read it carefully to help
make the code review process go as smoothly as possible and maximize the
likelihood of your contribution being merged.</p>
<div class="section" id="how-to-contribute">
<h2>11.1. How to contribute<a class="headerlink" href="#how-to-contribute" title="Permalink to this headline">¶</a></h2>
<p>The preferred workflow for contributing to pmdarima is to fork the
<a class="reference external" href="https://github.com/alkaline-ml/pmdarima">main repository</a> on
Github, clone, and develop on a branch. Steps:</p>
<ol class="arabic">
<li><p class="first">Fork the <a class="reference external" href="https://github.com/alkaline-ml/pmdarima">project repository</a>
by clicking on the ‘Fork’ button near the top right of the page. This
creates a copy of the code under your Github user account.</p>
</li>
<li><p class="first">Clone your fork of the pmdarima repo from your Github account to your
local disk:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ git clone https://github.com/alkaline-ml/pmdarima.git
$ <span class="nb">cd</span> pmdarima
</pre></div>
</div>
</li>
<li><p class="first">Create a <code class="docutils literal notranslate"><span class="pre">feature</span></code> branch to hold your development changes:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ git checkout -b my-feature
</pre></div>
</div>
<p>Always use a <code class="docutils literal notranslate"><span class="pre">feature</span></code> branch. It’s good practice to never work on the <code class="docutils literal notranslate"><span class="pre">master</span></code> branch!</p>
</li>
<li><p class="first">Develop the feature on your feature branch. Add changed files using <code class="docutils literal notranslate"><span class="pre">git</span> <span class="pre">add</span></code> and then <code class="docutils literal notranslate"><span class="pre">git</span> <span class="pre">commit</span></code> files:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ git add modified_files
$ git commit
</pre></div>
</div>
<p>to record your changes in Git, then push the changes to your Github account with:</p>
<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ git push -u origin my-feature
</pre></div>
</div>
</li>
</ol>
<p>5. Follow <a class="reference external" href="https://help.github.com/articles/creating-a-pull-request-from-a-fork">these instructions</a>
to create a pull request from your fork. This will send an email to the committers.</p>
</div>
<div class="section" id="pull-request-checklist">
<h2>11.2. Pull Request Checklist<a class="headerlink" href="#pull-request-checklist" title="Permalink to this headline">¶</a></h2>
<p>We recommended (and prefer that) that your contribution complies with the
following rules before you submit a pull request. Failure to adhere to the
rules may hinder the speed with which your contribution is merged:</p>
<ul>
<li><p class="first">Write detailed docstrings for all of your public functions. The preferred
format for docstrings is the <a class="reference external" href="https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt#docstring-standard">numpy standard</a>.
Also include usage examples where appropriate. See also the
<a class="reference external" href="https://numpydoc.readthedocs.io/en/latest/">Numpy guidelines for documenting your code</a></p>
</li>
<li><p class="first">Use, when applicable, the validation tools and scripts in the
<code class="docutils literal notranslate"><span class="pre">pmdarima.utils</span></code> submodule.</p>
</li>
<li><p class="first">Give your merge request a helpful title that summarizes what your
contribution does. In some cases <code class="docutils literal notranslate"><span class="pre">Fix</span> <span class="pre"><ISSUE</span> <span class="pre">TITLE></span></code> is enough.
<code class="docutils literal notranslate"><span class="pre">Fix</span> <span class="pre">#<ISSUE</span> <span class="pre">NUMBER></span></code> is not enough.</p>
</li>
<li><p class="first">If your pull request references an issue, reference it in the body of your
descriptive text using <code class="docutils literal notranslate"><span class="pre">#<ISSUE</span> <span class="pre">NUMBER></span></code></p>
</li>
<li><p class="first">Please prefix the title of your pull request with <code class="docutils literal notranslate"><span class="pre">[MRG]</span></code> (Ready for
Merge), if the contribution is complete and ready for a detailed review.
The core developers will then review your code and merge when approved.
An incomplete contribution – where you expect to do more work before
receiving a full review – should be prefixed <code class="docutils literal notranslate"><span class="pre">[WIP]</span></code> (to indicate a work
in progress) and changed to <code class="docutils literal notranslate"><span class="pre">[MRG]</span></code> when it matures. WIPs may be useful
to: indicate you are working on something to avoid duplicated work,
request broad review of functionality or API, or seek collaborators.</p>
</li>
<li><p class="first">All other tests pass when everything is rebuilt from scratch.
On Unix-like systems, check with (from the toplevel source folder):</p>
<blockquote>
<div><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ python setup.py develop
$ pytest
</pre></div>
</div>
</div></blockquote>
<p>You can also use the <code class="docutils literal notranslate"><span class="pre">Makefile</span></code> on posix machines:</p>
<blockquote>
<div><div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>$ make <span class="nb">test</span>
</pre></div>
</div>
</div></blockquote>
<p>You may need to see the <a class="reference internal" href="setup.html#setup"><span class="std std-ref">Setup</span></a> section for instructions on how
to build the package. For instructions on how to test (using pytest)
see <a class="reference external" href="https://github.com/numpy/numpy/blob/master/doc/TESTS.rst.txt">Numpy’s testing instructions</a>.</p>
</li>
</ul>
</div>
<div class="section" id="filing-a-bug">
<span id="filing-bugs"></span><h2>11.3. Filing a bug<a class="headerlink" href="#filing-a-bug" title="Permalink to this headline">¶</a></h2>
<p>We use Github issues to track all bugs and feature requests; feel free to
open an issue if you have found a bug or wish to see a feature implemented.</p>
<p>It is recommended to check that your issue complies with the
following rules before submitting:</p>
<ul class="simple">
<li>Verify that your issue is not being currently addressed by other
<a class="reference external" href="https://github.com/alkaline-ml/pmdarima/issues">issues</a>
or <a class="reference external" href="https://github.com/alkaline-ml/pmdarima/pulls">pull requests</a>.</li>
<li>If your issue references and pull request, reference it in the body of your
descriptive text using <code class="docutils literal notranslate"><span class="pre">!<PULL</span> <span class="pre">REQUEST</span> <span class="pre">NUMBER></span></code></li>
<li>Please include your operating system type and version number, as well
as your Python, statsmodels, scikit-learn, numpy, scipy, pandas and pmdarima
versions. This information can be found by running the following code
snippet:</li>
</ul>
<blockquote>
<div><div class="highlight-python notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">pmdarima</span> <span class="k">as</span> <span class="nn">pm</span><span class="p">;</span>
<span class="n">pm</span><span class="o">.</span><span class="n">show_versions</span><span class="p">()</span>
</pre></div>
</div>
</div></blockquote>
<ul class="simple">
<li>Please don’t be a <strong>lazy issue-filer!</strong> Submitting a screen shot of an Excel document,
or poorly-formatted/incomplete code makes the maintainers’ lives difficult. Please include your data inline
in a code-block so maintainers can easily try to replicate. What not to do:</li>
</ul>
<a class="reference internal image-reference" href="_images/bad_issue.png"><img alt="Bad issue" class="align-center" src="_images/bad_issue.png" style="width: 572.8000000000001px; height: 384.0px;" /></a>
<p>A better way to file the same issue (made up; this issue was not actually filed):</p>
<a class="reference internal image-reference" href="_images/good_issue.png"><img alt="Good issue" class="align-center" src="_images/good_issue.png" style="width: 568.0px; height: 361.6px;" /></a>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="contributors.html" class="btn btn-neutral float-right" title="12. Contributors" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="usecases/sun-spots.html" class="btn btn-neutral float-left" title="10.2. An end-to-end time series analysis" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2017-2023, Taylor G Smith
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>