How to contribute¶

Welcome! We are glad to have you visit our contributing guide!

If you find any bugs or have suggestions for improvements, please open an issue and optionally a pull request (PR). In the case of a PR, we would appreciate it if you preface it with an issue outlining your goal and means of achieving it.

Development setup¶

Install the dependencies using mise-en-place.

1

mise install

It will also install git commit hooks which are used for linting, type checking and to create the documentation.

git¶

We are using git submodules to import the KPOps examples repository. You need to fetch the repository locally on your machine. To do so use this command:

1
2

git submodule init
git submodule update --recursive

This will fetch the resources under the examples folder.