This file contains the guidelines for contributing to the project. Thank you for taking the time to contribute to this project 🙏🏽
If you spot a problem with :
- The code of the library
- The documentation
- The tests
- The CI/CD
Search if an issue already exists. If not, create a new one. Next, use the templates to create a new issue :
The commit message need to be clear and concise. It must be written in English and have the following suffixes:
[Feat]: For a feature[Fix]: For a fix[Doc]: For a documentation update[Test]: For a test update[CI]: For a CI/CD update[Clean]: For a code refacto
To create a pull request, you need to link it with an issue, create a new branch, and commit your changes on the branch.
If your Pull Request is in progress, you can change the status of the Pull Request to Draft and optionally add the WIP label to it.
A Pull Request can be solved by anyone only if the following conditions are met:
- All the tests pass
- The code is well documented
- All remarks are solved
Then, you can approve the Pull Request, and the author will be able to merge it.