Contributing

📜 Package is currently developed with an open-source philosophy, so any relevant contribution is welcome

General rules

In an ideal world, your code should be :

  • simple enough so your grandma can understand it

  • beautiful enough to make your cousin in art school want to read it

  • efficient enough such that you spend more time analyzing your plots than coding and running experiments

Of course, that’s an ideal goal … but nothing prevents to aim at the sky when reaching the top of the mountain 🚡

Recommended approach is to fork this repository, create a new branch in your fork named with the reason of your PR (don’t use main !), and open a pull request when ready. This will automatically trigger the CI pipeline that :

  1. check linting with flake8

  2. run all the tests defined in the tests folder, and upload a coverage report to codecov

  3. test all the tutorials located in the docs/notebook folder

Recommended merge strategy is to squash commits \(\Rightarrow\) you don’t have to care about the number of commit included in your PR, so don’t be scare of making mistakes before your PR is accepted 😉

🔔 Once your PR is accepted, please delete the development branch from your fork and synchronize your main branch. When creating a new development branch later, ensure that you start from an up-to-date main branch of your fork.

Base recipes

Some memos on how to develop this package …