Skip to content

Latest commit

 

History

History
42 lines (30 loc) · 944 Bytes

CONTRIBUTING.md

File metadata and controls

42 lines (30 loc) · 944 Bytes

Contributing to audio-purifier

Contributions are welcome! Here are some pointers to help you install the library for development and validate your changes before submitting a pull request.

Install the library for development

First create your own venv and activate it:

pythin -m venv .venv
source .venv/bin/activate

Then we recommend installing the module in editable mode with the dev extra requirements:

pip install -e .[dev]

To check it worked, use:

$ which pip

Result:

some/directory/audio-purifier/.venv/bin/pip

Validate the changes before creating a pull request

  1. Make sure the existing tests are still passing (and consider adding new tests as well!):
pytest tests/
  1. Reformat and validate the code with the following tools:
bash scripts/lint.sh [--fix]

These steps are also run automatically in the CI when you open the pull request.