Skip to content

Latest commit

 

History

History
41 lines (31 loc) · 2.01 KB

CONTRIBUTING.md

File metadata and controls

41 lines (31 loc) · 2.01 KB
Raw

How-to contribute

Those are the main contributing guidelines for contributing to this project:

  • Verify that your contribution does not embark proprietary code or infringe any copyright of any sort.
  • Avoid adding any unnecessary dependencies to the project, espcially of those are not easily packaged and installed through conda or pip.
  • Python contributions must follow the PEP 8 style guide.
  • Use Pull Request mechanism and please be patient while waiting for reviews.
  • Remain polite and civil in all exchanges with the maintainers and other contributors.
  • Any issue submitted which does not respect provided template, or lack of information, will be considered as invalid and automatically closed.

Get started

This project is managed using Poetry, in order to contribute, the safest is to create your own fork of spleeter first and then setup your development environment:

# Clone spleeter repository fork
git clone https://github.com/<your_name>/spleeter && cd spleeter
# Install poetry
pip install poetry
# Install spleeter dependencies
poetry install
# Run unit test suite
poetry run pytest tests/

You can then make your changes and experiment freely. Once you're done, remember to check that the tests still run. If you've added a new feature, add tests!

Then finally, you're more than welcome to create a Pull Request in Spleeter main repo. We will look at it as soon as possible and eventually integrate your changes in the project.

PR requirements

Following command should be ran successfully before to consider a PR for merging:

poetry run pytest tests/
poetry run black spleeter
poetry run isort spleeter