Skip to content

Latest commit

 

History

History
23 lines (14 loc) · 983 Bytes

CONTRIBUTING.md

File metadata and controls

23 lines (14 loc) · 983 Bytes

Code style: black License

Contributing to BraTS

First off, thanks for taking the time to contribute! 🎉

Contribute Code

Fork the repository, clone it and implement your contribution.

Setup:

  • We use poetry, make sure it is installed: pip install poetry
  • Install dependencies by running: poetry install

Requirements:

  • Our project follows the black code style. Make sure your code is formatted accordingly.
  • Please add meaningful docstring for your functions and annotate types
  • Please add meaningful tests for your contribution in /tests and make sure all tests are passing by running python -m pytest

Once done, create a Pull Request to integrate the code into our project!