Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
28 lines (19 loc) · 884 Bytes

CONTRIBUTING.md

File metadata and controls

28 lines (19 loc) · 884 Bytes
Raw

Contributing

This project is in early alpha and the API is evolving rapidly. We are not accepting pull requests at this time, but issues and bug reports are very welcome.

Issues and bug reports are welcome via the GitHub issue tracker.

Development Setup

Prerequisites

  • Go 1.26+
  • Docker
  • kubectl
  • kind (for local testing)

Build and Test

# Generate code, manifests, build, and run tests
make generate manifests build test

Code Style

  • Lint: golangci-lint run --no-config --enable revive,goconst,prealloc,staticcheck,unparam,gocyclo ./...
  • Table-driven tests with testify
  • Follow kubebuilder conventions
  • Context propagation and wrapped errors: fmt.Errorf("context: %w", err)