Contributing

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

General rules

Ideally, your code implementation 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

Current coverage is at 100%, so no untested line will be accepted 😇.

📣 Know that no code styling formatter (like black, or else …) will ever be imposed in CI, as long as I’m still breathing !

Chosen 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 this 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.

In case you are interested in contributing but don’t have any idea on what, checkout out current development roadmap 🎯 and project proposals 🎓

Base recipes

A few base memo on how to develop this package …

• General code structure

• Add a Runge-Kutta scheme

• Testing your changes

• Update this documentation

• Version update pipeline

Miscellaneous

• Code of Conduct
• Security Policy