Contributing

December 6, 2025 · View on GitHub

Pull requests and Github issues are welcome! Ask questions by posting to the H3 tag on StackOverflow

Pull requests

Please include tests that show the bug is fixed or feature works as intended.
Please add a description of your change to the Unreleased section of the changelog.
Please open issues to discuss large features or changes which would break compatibility, before submitting pull requests.
Please keep code coverage of H3-Go library near 100%.

Install dependencies:

go get -t ./...

Run tests:

go test

Generate coverage:

go test -coverprofile=covprofile && go tool cover -html=covprofile

Run lint:

golangci-lint run

Add VSCode configuration, or merge recommended settings into your existing settings:

git cherry-pick vscode

golangci-lint version 2 requires the pre-release version of the golang.go extension:

You may also be interested in contributing to the @uber/h3 repository, which includes more detailed documentation for the functions provided by H3-Go.