1.3 KiB
1.3 KiB
Contributing
Hi there! We're thrilled that you'd like to contribute to this project. Your help is essential for keeping it great.
Contributions to this project are released to the public under the project's open source license.
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.
Here are a few things you can do that will increase the likelihood of your pull request being accepted:
- Ensure your code is
go fmt
formatted and does not contain any unused imports. - If you introduce any new dependencies, use licensed's
cache
command to ensure their licenses are included in the repository and compiled binaries. - 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, consider submitting them as separate pull requests.
Releasing New Versions
Repository maintainers can release new versions by following this procedure:
- Tag the new version with a three-part semver version number.
- Push the tag.
- Ensure the GitHub Actions run triggered by this push completes successfully.