Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
46 lines (30 loc) · 1.55 KB

CONTRIBUTING.md

File metadata and controls

46 lines (30 loc) · 1.55 KB

Sign the CLA

Before you can contribute, you will need to sign the Contributor License Agreement.

Code of Conduct

Please make sure to read and observe our Code of Conduct.

Getting Started

Prerequisites

  • Go 1.26.1 or later (see .go-version)
  • Docker (for building images and running local dev environments)
  • kind (for local development clusters)
  • kubectl
  • AWS CLI (for integration and e2e tests)
  • jq (for integration tests)

Building

# Build binary for your current OS/arch
make bin

# Build binaries for all supported platforms
make build-all-bins

# Build Docker image
make image

The binary is written to _output/bin/.

Building and Testing

See docs/development.md for full instructions on building, running tests, linting, setting up a local kind environment, and code generation.

Submitting Changes

  1. Fork the repository and create a branch from master.
  2. Make your changes, including tests for any new behavior.
  3. Ensure make test and make lint pass.
  4. Open a pull request against master.

Pull requests are reviewed by the maintainers listed in OWNERS. Please allow a few business days for review.