This project is a community effort, and everyone is welcome to contribute.
The project is hosted on https://github.com/nilearn/nilearn
The best way to contribute and to help the project is to start working on known issues. See Good first issues to get started.
If an issue does not already exist for a potential contribution, we ask that you first open an issue before sending a :ref:`pull request`.
Nilearn uses issues for tracking bugs, requesting potential features, and holding project discussions.
Labels can be assigned a variety of issues, such as:
These issues discuss ongoing discussions on the project where community feedback is requested.
These issues discuss potential enhancements or additions to the project.
These issues detail known bugs in the Nilearn code base.
We welcome pull requests from all community members. We follow the same conventions as scikit-learn. You can find the recommended process to submit code in the scikit-learn guide to contributing code.
We use Git for version control and GitHub 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 to get the basics.
You can check out the latest sources with the command:
git clone git://github.com/nilearn/nilearn.git
or if you have write privileges:
git clone [email protected]:nilearn/nilearn.git
Nilearn follows the coding conventions used by scikit-learn. Please read them before you start implementing your changes.