.. _contributing:

============
Contributing
============

This project is a community effort, and everyone is welcome to
contribute.

The project is hosted on https://github.com/nistats/nistats

The best way to contribute and to help the project is to start working on known issues.
See `Easy issues <https://github.com/nistats/nistats/labels/Easy>`_ to get started.

Submitting a bug report
=======================

In case you experience issues using this package, do not hesitate to submit a ticket to the
`Bug Tracker <https://github.com/nilearn/nilearn/issues>`_. You are
also welcome to post feature requests or pull requests.

.. _git_repo:

Retrieving the latest code
==========================

We use `Git <http://git-scm.com/>`_ for version control and
`GitHub <https://github.com/>`_ for hosting our main repository. If you are new on GitHub and don't know how to work with it, please first have a look at `this <https://try.github.io/>`_ to get the basics.

You can check out the latest sources with the command::

    git clone git://github.com/nistats/nistats.git

or if you have write privileges::

    git clone git@github.com:nistats/nistats.git

Coding guidelines
=================

Nistats follows the coding conventions used by scikit-learn. `Please read them
<http://scikit-learn.org/stable/developers/contributing.html#coding-guidelines>`_
before you start implementing your changes.