Thanks for considering a contribution! The following are multiple ways you could go about your contribution for which you can find further explanation further below:

  • Adding new checks

  • Add documentation or tutorials

  • Reporting bugs

When contributing any code make sure to run

  • flake8

  • mypy

  • black

on the code and ensure the documentation builds and the tests pass. A .pre-commit-config.yaml configuration file is available if you want to use git pre-commit hooks.

Adding new checks

Right now the main thing that is missing is the implementation of various configuration checks. A good check must have the following properties:

Independence from state

A check has to work on just the textual configuration of the device. It may not depend on any state such as the operative status of an interface or the up/down status of a routing protocol neighbor.


A check must always be applicable to all of its assigned network operating systems (NOSes) regardless the context.


A check must always fulfill any of the following use cases:

  • Indicate redundant or unused configuration such as a feature that is enabled but never used or an access list that is configured but never applied

  • Indicate a security issue such as leaving telnet enabled

Write documentation or tutorials

The latest documentation is always present here. Take a look and see if you can find any typos, logical issues or unclear passages - contributions of any size are very welcome.

Reporting bugs

You can report issues here.