First off, thanks for taking the time to contribute! This guide will answer some common questions about how this project works.
While this is a Pinterest open source project, we welcome contributions from everyone.
- Fork this repository to your own account
- Make your changes and verify that
go testpasses - Commit your work and push to a new branch on your fork
- Submit a pull request
- Participate in the code review process by responding to feedback
Once there is agreement that the code is in good shape, one of the project's maintainers will merge your contribution.
To increase the chances that your pull request will be accepted:
- Follow the style guide
- Write tests for your changes
- Write a good commit message
We use gofmt-based code formatting. The format will be enforced by CI, so
please make sure your code is well formatted before you push your branch so
those checks will pass.
You can build the project and its dependencies using go build ..
You can run the thriftcheck command line tool using go run ./cmd.
Tests are written using the Go testing package.
Run them using the go test command.
Releases are built using GoReleaser, triggered
using a GitHub Actions Workflow whenever
a new tag is pushed to the repository. Version tags are prefixed with a v
(e.g. v1.0.0).
By contributing to this project, you agree that your contributions will be licensed under its Apache 2.0 license.