Contributing to Zoorik’s open source

• Search the open issues first. Someone may have reported it already.
• New here? Issues labelled good first issue (opens in a new tab) are small and say where to start.
• For a bug, use the bug report form: say what you did, what you expected and what happened, and include the version you ran.
• For a big change, open an issue first so we can agree on the approach before you spend time on it.
• Remove tokens, keys and other secrets from anything you paste.

Each repository’s README says how to run it and which checks CI runs. The three most people start with:

zoorikctl

You need Go, the version in go.mod.

$ git clone https://github.com/getzoorik/zoorikctl.git
$ cd zoorikctl
$ go build -o bin/zoorikctl ./cmd/zoorikctl
$ ./bin/zoorikctl version

Before a pull request, run the checks CI runs:

$ go mod tidy && git diff --exit-code go.mod go.sum
$ test -z "$(gofmt -l .)"
$ go vet ./...
$ go test ./...

assessment

Each script is one Python file that runs on Python 3.8 and later, with the standard library only. A local cluster (kind, minikube or k3d) is enough to try most changes to k8s.py:

$ python3 k8s.py --help
$ python3 k8s.py --context kind-kind --no-prices --sample-minutes 0

disks.py needs an Azure subscription; a small Linux VM with one data disk is enough. The repository’s contributing guide (opens in a new tab) lists the checks CI runs.

kubernetes-scenarios

A new scenario is a shape you met in a real cluster that is not in the library yet. Check it on kind:

$ scripts/validate.sh
$ kind create cluster --config kind/cluster.yaml
$ scripts/run.sh <new-name> kind-scenarios

1. Fork the repository and create a branch from main.

2. Make one change per pull request. Small pull requests are easier to review and land sooner.

3. Run the checks the repository’s README describes.

4. Open the pull request and fill in the template: what you changed, why, and how you tested it.

You do not need to sign off your commits or sign a contributor agreement. Our public repositories are licensed under Apache-2.0 (copyright Zoorik Private Limited), and what you send is licensed the same way, as section 5 of the license says.

• In zoorikctl, the assessment and kubernetes-scenarios, CI runs the repository’s checks on every pull request, and they must pass.
• A maintainer reviews every pull request and merges it.
• In kubernetes-scenarios, people test against each scenario, so a scenario’s shape changes only when it is wrong; a different shape is usually a new scenario.

Found a security problem? Do not open an issue. Report it privately from the repository’s Security tab with Report a vulnerability, or write to founders@zoorik.com. We reply within 3 working days to confirm we have your report. The security policy (opens in a new tab) has the details.

Everyone here follows our Code of Conduct (opens in a new tab). To report a problem, write to founders@zoorik.com.