Contributing

Full contribution guidelines are in CONTRIBUTING.md in the repository root. This page summarises the key points.

Ways to contribute

• Bug reports: Open an issue with operator version, Kubernetes version, steps to reproduce, and expected vs. actual behaviour.
• Feature requests: Open an issue describing the use case. Larger features should be discussed before implementation.
• Pull requests: Small bug fixes and documentation improvements are welcome directly. For non-trivial changes, open an issue first.
• Documentation: Improvements to the docs site are always welcome.

Development setup

git clone https://github.com/danihengeveld/mc-operator.git
cd mc-operator
dotnet tool restore
dotnet restore McOperator.slnx

Run tests:

dotnet run --project src/McOperator.Tests/

Docs site (uses Bun):

cd docs
bun install
bun run dev

Helm chart:

helm lint charts/mc-operator --strict

Pull request process

1. Fork and create a branch from main.
2. Make focused commits with descriptive messages.
3. Tests must pass: dotnet run --project src/McOperator.Tests/
4. Chart must lint: helm lint charts/mc-operator --strict
5. Update CHANGELOG.md and docs if behaviour changes.
6. Open a PR against main.

Commit style

fix: reject empty server version in validation webhook
feat: add custom JVM argument validation
docs: clarify storage immutability in CRD reference
chore: update KubeOps to 10.3.4
ci: add docs build step to CI workflow

Prefixes: feat, fix, docs, chore, refactor, test, ci.