Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.
Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.
- Check the issues or open a new one
- Fork this repository
- Create your feature branch:
git checkout -b my-new-feature - Commit your changes:
git commit -am 'feat: Add some feature' - Push to the branch:
git push origin my-new-feature - Submit a pull request linked to the issue 1.
Here are a few things you can do that will increase the likelihood of your pull request being accepted:
- Follow the overall style of the project
- Write tests
- Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, submit them as separate pull requests
- Write good commit messages following conventional commits
- Open a pull request with a title following conventional commits
In order to merge the pull request, you need to ensure:
- Have at least 2 approvals
- Last build pipeline must be successful
- Set the pull request to squash the commits to the
mainbranch - Write a good squash commit messages following conventional commits
- Maintainers agree by majority the next release version.
- A release is created with naming pattern: {Major}.{Minor}.{Patch}-{RC|beta(optional)}
- A release contains at least 1 new feature/bugfix to be published.
By sending us your contributions, you are agreeing that your contribution is made subject to the terms of our Contributor Ownership Statement