Thank you for investing your time in contributing to our project! Your contribution may be reflected on [Project Name](Project url) ✨.
In this guide you will get an overview of the contribution workflow.
Be sure to read carefully the README.md to correctly install and use the project
main
: This branch is used by the main website. To merge in this branch please do a PR (Pull Request) first from the develop branchdevelop
: This branch is used by the development website to preview new features. To merge in this branch please do a PR first from a feature or issue branchfeature/${feature_name}
: This branch purpose is to develop new features on the projectissue/${issue_number}
: This branch purpose is to solve issues reported by testers
hotfix
: This branch purpose is to do hotfixes directly to the main branch when an urgent production problem is detected.
Before committing, be sure to write a comprehensive and relevant commit message.
If you spot a problem with the docs, [search if an issue already exists](https://github.com/[Github url]/issues). If a related issue doesn't exist, you can open a new issue using a relevant [issue form](https://github.com/[Github url]/issues/new/choose).
Scan through our [existing issues](https://github.com/[Github url]/issues) to find one that interests you. You can narrow down the search using labels
as filters.