.. vim: set fileencoding=utf-8 :
.. Roy Wallace
.. 27 Mar 2012
.. 
.. Copyright (C) 2011-2013 Idiap Research Institute, Martigny, Switzerland
.. 
.. This program is free software: you can redistribute it and/or modify
.. it under the terms of the GNU General Public License as published by
.. the Free Software Foundation, version 3 of the License.
.. 
.. This program is distributed in the hope that it will be useful,
.. but WITHOUT ANY WARRANTY; without even the implied warranty of
.. MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
.. GNU General Public License for more details.
.. 
.. You should have received a copy of the GNU General Public License
.. along with this program.  If not, see <http://www.gnu.org/licenses/>.

.. _section-contributing:

========================================
 Contributing to the |project| Project
========================================

We're really glad you'd like to join the |project| team!
To make a contribution to |project|, we suggest you follow this procedure:

1. Fork the |project| git repository following the GitHub instructions here: `Fork A Repo`_

2. Make your changes and/or implement new functionality following the guide: :doc:`Development`

3. Ensure that your code:
  
  * follows the coding guidelines (see :ref:`section-python-coding-guidelines` and :ref:`section-cxx-coding-guidelines`)

  * compiles without problems!

  * is accompanied by extensive documentation.

  * is accompanied by unit tests. New code is not acceptable otherwise. If you are contributing a bug fix, you should supply a new unit test that fails before applying the fix and passes after applying the fix.

4. Make a pull request following the GitHub instructions here: `Send pull requests`_. 
   
Making a pull request will send your contribution to the |project| project maintainers, who will review the contribution and decide whether to pull it into the official |project| git repository.

Thanks for contributing to |project|!

.. include:: links.rst
.. _`the google python style guide`: http://google-styleguide.googlecode.com/svn/trunk/pyguide.html
.. _`fork a repo`: http://help.github.com/fork-a-repo/
.. _`send pull requests`: http://help.github.com/send-pull-requests/

