Contribution Guide

Contributions are highly welcome!

Before You Start

Open an issue before writing any code or documentation. This helps align on the approach early, avoids duplicated effort, and gives a chance to share context or flag related work before a pull request is opened.

DCO Sign-off

All commits must include a Developer Certificate of Origin (DCO) sign-off, certifying that you wrote the change or have the right to submit it. Add it with the -s flag:

git commit -s -m "your commit message"

Tests

make test           # unit and envtest tests, and the checks of the examples
make test-e2e       # e2e tests on a Kind cluster of their own; E2E_LABELS=<feature> runs one feature
make test-e2e-plan  # list every e2e spec, without a cluster

A user-facing feature comes with an example in examples/, which the docs show and an e2e spec applies, as users would. make test fails for an example that the API refuses, or that no docs page shows or no e2e spec applies. The e2e README explains how the specs are laid out and written.

Community

Feel free to ask questions, share ideas, or discuss topics in the #kokumi channel on CNCF Slack.