Contributions tips and tricks

[ManonMarchand]

Who can contribute?

Everyone. And there are lots of ways do do so. You could for example:

• ask a question in the 's 💫 Q&A, if something is not clear to you chances are that you're not the only confused reader and that our tutorials need a bit more explanations. Thanks for spotting the voids!
• report an error in the Issues. If you find anything that does not compile right or that does not get you the expected output, felicitation you found a bug! And bug reporters are our most useful allies, please don't keep them for yourselves 😉.
• suggest new code or edit tutorials directly

But how do I change the code?

Please follow these steps:

1. fork the repository , the button can be found at the top right of this window. This will create a copy of the tutorials repository in your own github account.
2. on your version, create a branch with an explicit name like add-new-fitting-method
3. locally in your machine, in this new branch, and in a clean new python environment install all dependencies by running python -m pip install -r requirements.txt -r requirements-dev.txt
4. run pre-commit install to get your git hooks ready to see if your commits are ok
5. if everything works, push your changes to your new branch on your forked repository. This will run the github action tests and you'll have a report about whether your changes work for ubuntu, windows and mac.
6. when you get all green lights ✔️ open a pull request to this repo 🙂