Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
20 lines (16 loc) · 873 Bytes

CONTRIBUTING.md

File metadata and controls

20 lines (16 loc) · 873 Bytes
Raw

Contributing to k8s-rightsizer

First off, thank you for considering contributing! It's people like you that make k8s-rightsizer a great tool.

How to contribute

  1. Fork the repository.
  2. Clone your fork (git clone ...).
  3. Create a branch for your feature or bugfix (git checkout -b feature/amazing-feature).
  4. Make your changes. Ensure your code follows Go best practices.
  5. Run tests: make test.
  6. Commit your changes using Conventional Commits.
  7. Push to your fork and open a Pull Request.

Local Development

  • You will need Go 1.25+.
  • We recommend using minikube to test the Job execution locally.
  • Use make build-bin to compile the binary.

Security

If you find a security vulnerability, please do NOT open an issue. Email security@k8srightsizer.com instead.