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. The required version is pinned in
go.mod. - Some integration tests use Ruby; install it through download | through Homebrew if you plan to run them.
- Fork and clone the repository.
- Build the extension:
make build. - Make sure the tests pass on your machine:
make test(orgo test -race ./...). - Make sure the code is formatted and vetted:
make fmt-checkandmake vet. - Create a new branch:
git checkout -b my-branch-name. - Make your change, add tests, and make sure the tests still pass.
- Push to your fork and submit a pull request.
- Pat yourself on the back and wait 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:
- Follow the Go style guide and match the conventions in
AGENTS.md. - 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.