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.
These are one time installations required to be able to test your changes locally as part of the pull request (PR) submission process.
- install Go through download | through Homebrew
- install golangci-lint
- Fork and clone the repository
- Configure and install the dependencies:
go mod tidy - Make sure the tests pass on your machine:
go test -v ./... - Make sure linter passes on your machine:
golangci-lint run - Create a new branch:
git checkout -b my-branch-name - Make your change, add tests, and make sure the tests and linter still pass
- Push to your fork and submit a pull request
- Please be patient while waiting for your pull request to be reviewed and merged.
Here are a few things you can do that will increase the likelihood of your pull request being accepted:
- 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.
- Write a good commit message.