Contributing guidelines
=======================

This page explains how you can contribute to the development of `statsmodels`
by submitting patches, statistical tests, new models, or examples. 

`statsmodels` is developed on `Github <https://github.com/statsmodels/statsmodels>`_ 
using the `Git <http://git-scm.com/>`_ version control system. 

License
~~~~~~~

Statsmodels is released under the 
`Modified (3-clause) BSD license <http://www.opensource.org/licenses/BSD-3-Clause>`_.

Submitting a Patch
~~~~~~~~~~~~~~~~~~

So you want to submit a patch to `statsmodels`?. Great news! Here are the 
steps you need to take.

1. `Fork <https://help.github.com/articles/fork-a-repo>`_ the `statsmodels repository <https://github.com/statsmodels/statsmodels>`_ on Github.
2. `Create a new feature branch <http://git-scm.com/book/en/Git-Branching-Basic-Branching-and-Merging>`_
    + Each branch must be self-contained, with a single new feature or bugfix. 
    + Patches must always include tests. See our `notes on testing <test_notes.html>`_.
3. `Submit a pull request <https://help.github.com/articles/using-pull-requests>`_ 

Mailing List
~~~~~~~~~~~~

Conversations about development take place on the `statsmodels mailing list <http://groups.google.com/group/pystatsmodels?hl=en>`__.

Learn More
~~~~~~~~~~

The ``statsmodels`` documentation's `developer page <http://statsmodels.sourceforge.net/stable/dev/index.html>`_ 
offers much more detailed information about the process.
