How to contribute
In this document we will cover how contribute to the project and the rules associated to the process. We gladly accept all kinds of contributions, from writing new features and fixing bugs to improve the existing documentation. When contributing to the project the code of conduct must be followed.
We welcome any help you can offer and are eagerly waiting for your contributions. Feel free to ask for assistance or guidance at any time. We encourage you to get involved because contributing to open source projects allows you to collaborate with other members, improve your coding skills, and enhance your communication abilities.
🖐️ Steps to Contribute
- Select an issue and ask to work on it by leaving a comment in the issue page(Not in Trello).
- Create a new branch with the feature you're implementing using the branch naming convention.
- Push your changes to the new branch using the commit naming convention.
- Add tests for every functionality changed or added.
- Go to your branch in Github, then select Pull Request and fill the fields indicated in the template. Remember to rename the Pull Request using our convention.
It's important to leave a comment about working on an issue so the maintainer can add you as an assignee and avoid two people working on the same issue.
Trello links are used to synchronize Github issues with board tasks, we're not accepting new members due to free tier limitation until you have contributed at least twice.
🙍♂️ Contributors list
Once you contribute to the project, your name and GitHub profile will be added into the CONTRIBUTORS list as an acknowledgement for your work and in order to thank you.
📦 Required Software
- Node >= 20.12.2
- Python >= 3.11
- Git
- Docker & Docker Compose