Contributing to Connectome Mapper 3
The development philosophy for this new version of the Connectome Mapper is to:
- Enhance interoperability by working with datasets structured following the Brain Imaging Data Structure structured dataset.
- Keep the code of the processing as much as possible outside of the actual main Connectome Mapper code, through the use and extension of existing Nipype interfaces and an external library (dubbed cmtklib).
- Separate the code of the graphical interface and the actual main Connectomer Mapper code through inheritance of the classes of the actual main stages and pipelines.
- Enhance portability by freezing the computing environment with all software dependencies installed, through the adoption of the BIDS App framework relying on light software container technologies.
- Adopt best modern open-source software practices that includes to continuously test the build and execution of the BIDS App with code coverage and to follow the PEP8 and PEP257 conventions for python code and docstring style conventions. The use of an integrated development environment such as PyCharm or SublimeText with a python linter (code style checker) is strongly recommended.
- Follow the all contributors specification to acknowledge any kind of contribution.
This means that contributions in many different ways (discussed in the following subsections) are welcome and will be properly acknowledged!
If you have contributed to
CMP3 and are not listed as contributor, please add yourself and make a pull request.
This also means that further development, typically additions of other tools and configuration options should go in this direction.
Report bugs at https://github.com/connectomicslab/connectomemapper3/issues.
If you are reporting a bug, please include:
- Your operating system name and version.
- Any details about your local setup that might be helpful in troubleshooting.
- Detailed steps to reproduce the bug.
Look through the GitHub issues for bugs. Anything tagged with "bug" and "help wanted" is open to whoever wants to implement it.
Look through the GitHub issues for features. Anything tagged with "enhancement" and "help wanted" is open to whoever wants to implement it.
Possible enhancements are probably to be included in the following list:
- Adding of a configuration option to an existing stage
- Adding a new interface to cmtklib
- Adding of a new stage
- Adding of a new pipeline
The adding of newer configuration options to existing stages should be self-understandable. If the addition is large enough to be considered a "sub-module" of an existing stage, see the Diffusion stage example.
Adding a new stage implies the addition of the stage folder to the cmp/stages and cmp/bidsappmanager/stages directory and according modification of the parent pipeline along with insertion of a new image in cmp/bidsappmanager/stages. Copy-paste of existing stage (such as segmentation stage) is recommended. Note that CMP3 adopts a specific style for code dedicated to the connection of stages and interfaces, which is as follows:
[...] # fmt: off anat_flow.connect( [ (seg_flow, parc_flow, [("outputnode.subjects_dir", "inputnode.subjects_dir"), ("outputnode.subject_id", "inputnode.subject_id")]), (seg_flow, anat_outputnode, [("outputnode.subjects_dir", "subjects_dir"), ("outputnode.subject_id", "subject_id")]), [...] ] ) # fmt: on [...]
The # fmt: off and # fmt: on flags protect the lines to be reformatted by BLACK.
Adding a new pipeline implies the creation of a new pipeline script and folder in the cmp/pipelines and cmp/bidsappmanager/pipelines directories Again copy-pasting an existing pipeline is the better idea here. Modification of cmp/project.py and cmp/bidsappmanager/project.py file is also needed.
Each new module, class or function should be properly documented with a docstring in accordance to the Numpy docstring style.
CMP3 could always use more documentation, whether as part of the official CMP3 docs, in docstrings, or even on the web in blog posts, articles, and such.
When you commit changes related to the documentation, please always insert at then end of your message
[skip ci] to not perform continuous integration of the whole project with CircleCI.
The best way to send feedback is to create an issue at https://github.com/connectomicslab/connectomemapper3/issues.
If you are proposing a feature:
- Explain in detail how it would work.
- Keep the scope as narrow as possible, to make it easier to implement.
- Remember that this is a volunteer-driven project, and that contributions are welcome :)
Ready to contribute? Here's how to set up
Connectome Mapper 3 for local development.
Fork the connectomemapper3 repo on GitHub.
Clone your fork locally:
git clone firstname.lastname@example.org:your_name_here/connectomemapper3.git cd connectomemapper3
Create a branch for local development:
git checkout -b name-of-your-bugfix-or-feature
Now you can make your changes locally. If you add a new node in a pipeline or a completely new pipeline, we encourage you to rebuild the BIDS App Docker image (See :ref:`BIDS App build instructions <instructions_bidsapp_build>`).
Please keep your commit the most specific to a change it describes. It is highly advice to track un-staged files with
git status, add a file involved in the change to the stage one by one with
git add <file>. The use of
git add . is highly discouraged. When all the files for a given change are staged, commit the files with a brief message using
git commit -m "[COMMIT_TYPE]: Your detailed description of the change." that describes your change and where
[COMMIT_TYPE] can be
[FIX] for a bug fix,
[ENH] for a new feature,
[MAINT] for code maintenance and typo fix,
[DOC] for documentation,
[CI] for continuous integration testing,
[UPD] for dependency update,
[MISC] for miscellaneous.
When you're done making changes, push your branch to GitHub:
git push origin name-of-your-bugfix-or-feature
Submit a pull request through the GitHub website.
Before you submit a pull request, check that it meets these guidelines:
- If the pull request adds functionality, the docs and tests should be updated (See :ref:`documentation build instructions <instructions_docs_build>`).
- Python code and docstring should comply with PEP8 and PEP257 standards.
- The pull request should pass all tests on GitHub.
Go to the clone directory of your fork and run the script
cd connectomemapper3 sh scripts/build_bidsapp.sh
Tag of the version of the image is extracted from
cmp/info.py. You might want to change the version in this file to not overwrite an other existing image with the same version.
To generate the documentation:
Install the CMP3 conda environment
py37cmp-gui:$ cd connectomemapper3 $ conda env create -f environment.yml
Activate CMP3 conda environment
py37cmp-gui:$ conda activate py37cmp-gui
Install all dependencies such as sphinx and its extensions, required for the build:(py37cmp-gui)$ pip install -r docs/requirements.txt
connectomemapper3:(py37cmp-gui)$ pip install .
Run the script
scripts/build_docs.shto generate the HTML documentation in
docs/_build/html:(py37cmp-gui)$ sh scripts/build_docs.sh
Make sure to have (1) activated the conda environment
py37cmp-guiand (2) reinstalled
|Authors:||Sebastien Tourbier, Adrien Birbaumer|
We thanks the authors of these great contributing guidelines, from which part of this document has been inspired and adapted.