Contributing¶
Nipoppy is under active development, and we welcome outside contributions!
Please report bugs or start a conversation about potential enhancements/new features by opening a new GitHub issue.
Developer setup¶
Fork the repository on GitHub, then clone it and install it with dev dependencies, following instructions from here.
Set up pre-commit to apply automatic formatting/linting/etc. when making a new commit:
$ pre-commit install
Running the test suite¶
Within the root directory of the repo, run:
$ python -m pytest
Building the documentation¶
Move the the docs directory:
$ cd docs
Run:
$ make html
Then open the build/html/index.html file in a browser.