🤝 Contributing to Zelyo Operator¶

Thank you for your interest in contributing to Zelyo Operator! Whether you're fixing a bug, adding a feature, or improving documentation — every contribution makes Zelyo better for the community.

Code of Conduct¶

By participating in this project, you agree to abide by our Code of Conduct.

🗺️ How to Contribute¶

Reporting Issues¶

Use GitHub Issues for bug reports and feature requests
Security vulnerabilities: Please see our Security Policy — do not use public issues
Include reproduction steps, expected behavior, and actual behavior
Include your Kubernetes version, Zelyo Operator version, and cloud provider

Pull Requests¶

Fork the repository and create a feature branch from main
Follow the commit conventions below
Write tests for new functionality
Ensure all CI checks pass (make lint test)
Update documentation if your change affects user-facing behavior
Submit a PR against main

Commit Conventions¶

We follow Conventional Commits:

<type>(<scope>): <description>

[optional body]

[optional footer(s)]

Types	Scopes
`feat`, `fix`, `docs`, `style`, `refactor`	`scanner`, `monitor`, `llm`, `remediation`
`perf`, `test`, `build`, `ci`, `chore`	`dashboard`, `notifier`, `helm`, `api`, `crd`, `ci`

Examples:

feat(scanner): add RBAC over-permission detection
fix(llm): respect hourly token budget limits
docs(api): add OpenAPI spec for incidents endpoint

🛠️ Development Setup¶

Prerequisites¶

Go 1.25+
Docker
kubectl
kind or minikube
Kubebuilder 4.x
Helm 3.x

Getting Started¶

# Clone your fork
git clone https://github.com/<your-username>/zelyo-operator.git
cd zelyo-operator

# Add upstream remote
git remote add upstream https://github.com/zelyo-ai/zelyo-operator.git

# Install dependencies
make install

# Generate manifests and code
make manifests generate

# Run tests
make test

# Run locally against a kind cluster
kind create cluster --name zelyo-operator-dev
make install  # Install CRDs
make run      # Run the operator

Project Structure¶

├── api/v1alpha1/          # CRD type definitions
├── cmd/                   # Entrypoint
├── config/                # Kubebuilder kustomize configs
├── deploy/helm/           # Helm chart
├── docs/                  # Documentation
├── internal/
│   ├── controller/        # Kubebuilder controllers
│   ├── webhook/           # Admission webhooks
│   ├── llm/               # LLM client (BYO keys)
│   ├── scanner/           # Security scanner
│   ├── monitor/           # Real-time monitoring
│   ├── anomaly/           # Anomaly detection
│   ├── compliance/        # Compliance frameworks
│   ├── costoptimizer/     # Cost optimization
│   ├── drift/             # Config drift detection
│   ├── remediation/       # GitOps fix generator
│   ├── notifier/          # Alert routing
│   ├── dashboard/         # Embedded web UI
│   ├── api/               # REST API
│   └── ...
└── hack/                  # Development scripts

Make Targets¶

Target	Description
`make build`	Build the operator binary
`make test`	Run all tests
`make lint`	Run golangci-lint
`make manifests`	Generate CRD manifests
`make generate`	Generate deep copy methods
`make docker-build`	Build Docker image
`make install`	Install CRDs into cluster
`make run`	Run operator locally

🧪 Testing¶

Unit tests: Place in the same package as the code being tested
Integration tests: Use envtest (Kubebuilder's test framework)
Coverage: Aim for >80% coverage on new code

# Run all tests with coverage
make test

# Run specific package tests
go test ./internal/scanner/... -v

❓ Questions?¶

Open a Discussion for questions about the project.

Thank you for contributing to Zelyo Operator! 🎉