Skip to content

Latest commit

 

History

History
31 lines (21 loc) · 1.02 KB

CONTRIBUTING.md

File metadata and controls

31 lines (21 loc) · 1.02 KB

Developer guide

PR vs feature requests

For a feature request, please create an issue before doing any PR.

The reason for this is simple: we are working very actively on the subject, and you might work on an implementation already designed on our side.

Requirements

unit and integrations tests are mandatory.

Please use Conventional Commits.

Please ensure you have run the following before pushing a commit:

  • black and isort (or invoke reformat)
  • pylama to run all linters

About the logic:

  • implementation must be done for all Network OS supported, with the same behavior
  • the templates must be as simple as possible (max nested block: three levels)
  • the complexity should be in the state modules

Coding style

Follow usual best practices:

  • document your code (inline and docstrings)
  • constants are in upper case
  • use comprehensible variable name
  • one function = one purpose
  • function name should perfectly define its purpose