Contributing

Thanks for your interest in contributing! We welcome ideas, code, docs, etc -- just open an issue or MR.

Setup

This project uses flakes so a development environment can be created with

nix develop

NOTE: there's also support for direnv to automate the dev shell process

There's no formal commit process at this time.

Do try to format the repo with treefmt before submission, however.

nix fmt

To support a new Kubernetes version:

Edit ./versions.nix and add a new attribute for the version; for example:

{
  "1.23.0" = "sha256:0jivg8nlxka1y7gzqpcxkmbvhcbxynyrxmjn0blky30q5064wx2a";
}

Build and copy the updated specs to modules/generated/ with
```
nix run '.#generate'
```

Tests are executed through GitHub actions; see the workflow definition for commands.

Build and serve the static site

nix run '.#docs' serve

which will be available at http://localhost:1313.