Contributing to NetConfig

How to Contribute to NetConfig

You can contribute to NetConfig in multiple ways.

Bugs/Issues

If you encounter a bug when using NetConfig, you can submit a new issue on GitHub at https://github.com/v1tal3/netconfig/issues

Please provide as much detail as possible, including:

• Exact steps taken to reproduce issue
• Any error messages you see
• Version of NetConfig you are using
• Any (non-private) information on the affected device (if your issue is with a specific device/model)

Feature Requests

If you have a feature request, you can file it on the issue submission page on GitHub at https://github.com/v1tal3/netconfig/issues

Please provide as much relevant detail into your request as possible.

Pull Requests

If you have a code contribution you’d like to make, pull requests are encouraged! All pull requests will reviewed, and feedback will be provided, regardless of if it’s accepted, rejected, or changes are requested first.

Please make sure to test any pull requests thoroughly on the latest Development branch changes.

A few requirments for any code contributions:

• Submit all pull requests on the ‘development’ branch in GitHub
• Test all pull requests as thoroughly as possible
• Note any bugs, outstanding issues, or anything that still needs to be tested (if you were unable to test a part)

• All submit .py files must adhere to PEP8/Flake8 standards. Currently, all NetConfig .py files adhere to Flake8 standards, with a few exceptions:

  • E501 - line too long (82 > 79 characters)
  • N802 - function name should be lowercase
  • N803 - argument name should be lowercase
  • N806 - variable in function should be lowercase

Documentation

Any and all documentation submissions are welcome. If you submit detailed documentation, I will be happy to format it and introduce it properly into the official readthedocs.io documentation.