How to contribute
Support and contributions from the open source community are essential for keeping
up to date and always improving! There are a few guidelines that we need
contributors to follow to keep the project consistent, as well as allow us to keep
maintaining in a reasonable amount of time.
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.
Creating an Issue
Before you create a new Issue:
- Please make sure there is no open issue yet.
- If it is a bug report, include the steps to reproduce the issue and please create a reproducible test case.
- If it is a feature request, please share the motivation for the new feature and how you would implement it.
- Please include links to the corresponding GitHub documentation.
Making Changes
- Create a topic branch from the main branch.
- Check for unnecessary whitespace / changes with
git diff --check before committing.
- Keep git commit messages clear and appropriate. Ideally follow commit conventions described below.
Submitting the Pull Request
- Push your changes to your topic branch on your fork of the repo.
- Submit a pull request from your topic branch to the main branch on the `` repository.
- Be sure to tag any issues your pull request is taking care of / contributing to. * Adding “Closes #123”
to a pull request description will auto close the issue once the pull request is merged in.
Merging a PR and Shipping a release (maintainers only)
- A PR can only be merged into main branch by a maintainer if: CI is passing, approved by another maintainer and is up-to-date with the default branch.
- Ensure that the PR is tagged with related issue it intends to resolve.
- Change log for all the PRs merged since the last release should be included in the release notes.
- Automatically generated release notes is configured for the repo and must be used while creating a new release tag.