Contributing & Development⚓

Ways to Contribute⚓

There are several ways you can contribute to the Locust K8s Operator project:

For Everyone⚓

• Reporting Issues: Found a bug or have a feature request? Open an issue 👋
• Documentation: Help improve the documentation by suggesting clarifications or additions
• Community Support: Answer questions and help others in the issue tracker

For Developers⚓

Note: The following sections are intended for developers who want to contribute code to the project. If you're just using the operator, you can skip these sections.

• Code Contributions: Implement new features or fix bugs
• Testing: Improve test coverage and test in different environments
• Review: Review pull requests from other contributors

Project Status⚓

The project is actively maintained and is under continuous development and improvement. If you have any request or want to chat, kindly open a ticket. If you wish to contribute code and/or ideas, please review the development documentation below.

Technology Stack⚓

The operator is built with Go using the controller-runtime framework. Key technologies:

• Language: Go 1.26+
• Framework: controller-runtime / Operator SDK
• Testing: envtest, Ginkgo, Kind
• Build: Make, Docker
• Deployment: Helm, Kustomize

Development Documentation⚓

For developers contributing to the Locust K8s Operator project, we provide detailed documentation on various development aspects:

• Local Development Guide: Setting up your development environment
• Testing Guide: Running unit, integration, and E2E tests
• Pull Request Process: Guidelines for submitting code changes
• How It Works: Architecture overview

You can also refer to the comprehensive CONTRIBUTING.MD file in the GitHub repository for more information.