👏🎉 Thank you for taking the time to contribute! 🎉👏
We really value your willingness to contribute to this project. In order to higher the chances of your contribution being accepted, please refer to the following guidelines!
- Fork it!
- Create your feature branch:
git checkout -b feature/xyz develop. - Commit your changes according to our commit message standards:
git commit -m 'feat(xyz): Added new functionality'. - Push to your repo:
git push origin feature/xyz. - Submit a pull request to
develop!
This repo uses Gitflow as its branch management system. You can learn more about Gitflow here. A few quick tips:
- All feature branches should be based on
developand have the formatfeature/branch_name. - Minor bug fixes should be based on
masterand have the formathotfix/branch_name.
In order to make the changelog generation easier we recommend the use of messages based on Conventional Commits.
Examples:
feat(orders): added `XYZ` helper function
commit description
footer notes
refactor(orders): refactored `ABC` helper function
The behaviour of `ABC` was inconsistent and (...)
BREAKING CHANGE: return type of `ABC` is now `String`
docs: updated documentation in README.md