Contributing Guidelines

February 18, 2026 · View on GitHub

We are grateful for your willingness to contribute to this project! We are interested in any features, bug fixes, new usage examples, etc.

How to Contribute

  1. Fork this repository, develop, and test your changes.
  2. Submit a pull request.
  3. Make sure all GitHub actions pass successfully.

NOTE: In order to make testing and merging of PRs easier, please submit changes for different fixes/features/improvements in separate PRs.

Technical Requirements

  • Must pass the CI job for linting. Please run make lint in the root of the project to know if the project complies with the requirements.
  • New code must be covered by unit tests and pass the corresponding CI job. Please run make test-unit in the root of the project.
  • The project must pass integration tests. Please run make prepare-dev-environment && make test-e2e in the root of the project.
  • All changes require reviews from the responsible organization members before the merge.

Once changes have been merged, the release will be done by the responsible organization members.

🛠 Development

You can easily run the operator by following these steps:

  1. Init the project and make changes. The project depends on uv; therefore, please make sure to install it first
make init-project
  1. Create a Kubernetes cluster, install NetBox, and the operator.
make prepare-dev-environment

Alternatively, configure the environment variables according to the config file and run the project.

export NAMESPACE="default"
kopf run main.py --verbose -A
  1. Destroy the cluster once you are done testing your changes.
make cluster-delete