We're always open to contributions to this project! Below are some small guidelines to follow when submitting any Pull Requests for this project. Thanks for contributing!
Participation in this project comes under the Contributor Covenant Code of Conduct.
In order to contribute to this project, please note:
- We follow the GitHub Pull Request Model for all contributions.
- For new features, documentation must be included.
- All submissions require review before being merged.
- Once review has occurred, please squash your Pull Request into a single commit and rebase it.
- Write meaningful commit message for your contribution.
- See this blog post for choosing the right logging levels.
- Please follow the code formatting instructions below.
Please note the following rules for formatting your code:
- Format all Go code with gofmt. You may also use goimports which
fixes import statements and formats code in the same style of
gofmt. - Remove trailing whitespaces in all files.
- Ensure any new or modified files have a trailing newline.
This project comes also with an .editorconfig that should already handle most of the cases outlined above will always be extended to match these criteria as close as possible.
Automatic checks are performed through GitHub Actions and run for every submitted Pull Request. They are all expected to run without any warnings or errors, until the Pull Request will be merged. Please look into the output of the Workflows that were executed on your Pull Request to check whether everything complies with our checks.