Contributor Guide

How to contribute

The Netchecks project is open source and welcomes contributions from the community. There are many ways to contribute to the project, including:

  • Reporting bugs
  • Suggesting new features
  • Contributing code
  • Contributing documentation

The place to start is GitHub. If you find a bug or have a feature request, please open an issue in the appropriate repository. If you want to contribute code, please open a pull request.

Code Repository

The code is available under the netchecks Github repository.


Documentation is available in the folder netchecks/docs.

Netcheck Probe

The command line tool that runs the network probes is called netcheck. It is implemented in Python and is available as a PyPi package. The source code is available in the netchecks repository on GitHub.

Netcheck Operator

The netchecks operator is implemented in Python using the kopf framework and is available in the operator folder on GitHub.