Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
41 lines (27 loc) · 2.32 KB

CONTRIBUTING.md

File metadata and controls

41 lines (27 loc) · 2.32 KB
Raw

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. This project is licensed under the MIT License; by contributing you agree that your contributions are licensed under the same terms (inbound=outbound).

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.

Prerequisites for running and testing code

These are one time installations required to be able to test your changes locally as part of the pull request (PR) submission process.

  1. Install Go 1.19 or newer through download | through Homebrew

The Go module lives under go/.

Submitting a pull request

  1. Fork and clone the repository
  2. Make sure the tests pass on your machine: make test
  3. Make sure the linter passes on your machine: make lint
  4. Create a new branch: git checkout -b my-branch-name
  5. Make your change, add tests, and make sure the tests and linter still pass
  6. Push to your fork and submit a pull request
  7. 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:

  • 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 tests.
  • Write a good commit message.
  • Schema changes require coordination with github/gh-actions-lock, the lockfile's primary producer. See RELEASING.md.

Resources