Skip to content

Contributing

Contributors: https://github.com/boisgera/bitstream/graphs/contributors

Bitstream is developped on GitHub. To contribute, please open an issue or submit a pull request for the code or documentation. The following sections should help you to get started.

Getting Started

Follow the steps required to install from sources and make sure that you have installed all the developer dependencies (pip install -r requirements-dev.txt).

Run the Tests

To run all the tests, type

 $ python test.py

If nothing happens, your version of bitstream is probably fine: all the code snippets used in the documentation have been checked by doctest and have correct outputs. To find out more about these tests, run

 $ python test.py -v

The bitstream project uses Travis CI to run all the tests on each new commit. If you fork bitstream, make sure to activate Travis CI. To add new tests, just update the documentation.

Documentation

The documentation is built with MkDocs and its Material theme.

The documentation sources are markdown files located in the mkdocs directory and assembled according to the configuration file mkdocs.yml. Build the docs2 with

$ mkdocs build

This command outputs HTML documentation into the docs directory.

  1. pip install pyyaml ↩

  2. For work in progress, use mkdocs serve: it creates a web server that listens on http://127.0.0.1:8000 and refreshes automatically the documentation when its source files change. ↩