-
Notifications
You must be signed in to change notification settings - Fork 16
Contributing
Leonardo Gresta Paulino Murta edited this page Jan 30, 2025
·
7 revisions
Is this your first time contributing here? Try some good first issues to start. But remember to post your intended solution in the issue to discuss with the team before starting coding.
If you want to contribute to our project and DO NOT BELONG TO THE MAIN TEAM, follow these steps:
- Fork the repo
- Choose the correct branch to base your contribution (see details below)
- Implement and test your code
- Submit a pull request
If you DO BELONG TO THE MAIN TEAM, just follow steps 2 and 3.
We use different branches for different purposes. Our develop branch is for evolutive maintenance, where feature branches emerge for major tasks. Moreover, we have a main branch for corrective maintenance. So, choose the correct branch depending on the issue type:
- Evolutive: all new features should be coded in a feature branch based on the develop branch.
- Corrective: all bug fixes and dependencies updates should be coded in the main branch. As we do not support old versions, these fixes will be released only for the most recent version.