Contributing

By participating in this project, you agree to abide our code of conduct.

Set up your machine

NOTE: we do not currently support Windows development, thus the following is applicable for Linux and Darwin.

Prerequisites:

To install the required CLI tools:

make cli-install

Clone kcm anywhere:

git clone https://github.com/k0rdent/kcm.git

cd into the directory and install the dependencies:

go mod tidy

Build then the binaries:

make build

When you are satisfied with the changes you have made, run linter, and unit- and env-tests:

make lint test

Before you commit the changes, generate the code and templates. Optionally, a base and a head commits to diff changes from can be set:

make generate-all
# or
make BASE_COMMIT=origin/main HEAD_COMMIT=HEAD generate-all

To run E2E tests, please refer to the corresponding section of the dev docs.

Commit messages should follow the Conventional Commits convention.

Push your branch to your fork, and open a new pull request against the main branch.

Please make sure that the title of the PR also follows the Conventional Commits convention.