CONTRIBUTING.md

March 27, 2023 · View on GitHub

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.

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.

Open an issue

Thank you for wanting to contribute, we’d love to chat about it!

To propose a new feature or a change to existing functionality, please open an issue to discuss the use case, your intended approach, tradeoffs, and other relevant context. You can include code snippets if it’s helpful! All ideas are welcome, however it’s important to have alignment before contributions will be considered.

Once there is agreement, you can move on to submitting a pull request.

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 through download | through Homebrew
  2. install golangci-lint

Submitting a pull request

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

Resources