Contributing and Reporting Bugs¶

Submitting Bug Reports¶

To file a bug report or request a feature submit a new issue to our GitHub Issue Tracker

Contributing¶

Fork our GitHub repository , create a new topic branch with your feature/fix, and send pull request with a comment that describes your changes.

All pull requests should pass our test suite and include tests for any new features/fixes. More information about the test suite can be found here

In addition to adding tests, pull requests should include updated documentation. Documentation is located in the /docs/source directory. Scripts are included to generate html documentation locally.

On linux systems:

cd python-bandwidth
make html_docs

On Windows:

cd python-bandwidth/docs
make.bat html

For more information on the format of the docs refer to the official Sphinx Docs