Skip to content

Latest commit

 

History

History
49 lines (30 loc) · 1.04 KB

CONTRIBUTING.rst

File metadata and controls

49 lines (30 loc) · 1.04 KB

Contributing

If you find any bugs or other things that need improvement, or would like to add additional features, please create an issue or a pull request at https://github.com/sonos/pyFLAC.

You get started, grab the latest version of the code from GitHub:

git clone https://github.com/sonos/pyFLAC.git
cd pyflac

To build the package:

python3 pyflac/builder/encoder.py

python3 pyflac/builder/decoder.py

you can also install your local copy with pip:

pip3 install .

Before submitting a pull request, make sure all tests are passing and the test coverage has not decreased.

Testing

To run the test suite:

tox -r

Documentation

If you make changes to the documentation, you can locally re-create the HTML pages using Sphinx. You can install it and the read the docs theme with:

pip3 install -r docs/requirements.txt

To create the HTML pages, use:

cd docs
make html

The generated files will be available in the directory docs/_build/html.