Contributor Guide#

Thank you for your interest in improving this project. This project is open-source under the MIT license and welcomes contributions in the form of discussions, bug reports, feature requests, and pull requests.

Here is a list of important resources for contributors:

How to report a bug#

Report bugs on the Issue Tracker.

When filing an issue, make sure to answer these questions:

  • Which operating system and Python version are you using?

  • Which version of this project are you using?

  • What did you do?

  • What did you expect to see?

  • What did you see instead?

The best way to get your bug fixed is to provide a test case, and/or steps to reproduce the issue. A playlist file (example) saved with your region encoding could help as well.

How to request a feature#

Request features on the Discussions.

How to set up your development environment#

You need Python (with supported version on the project) and the following tools:

Install the package with development requirements:

$ poetry install

You can now run an interactive Python session, or the command-line interface:

$ poetry run python
$ poetry run playlist-along

How to test the project#

Run the full test suite:

$ nox

Attention

If you use PowerShell on Windows as your terminal, try to run each Nox command adding .exe

nox.exe

List the available Nox sessions:

$ nox --list-sessions

You can also run a specific Nox session. For example, invoke the unit test suite like this:

$ nox --session=tests

Unit tests are located in the tests directory, and are written using the pytest testing framework.

How to submit changes#

Important

It is recommended to open an issue before starting work on anything. This will allow a chance to talk it over with the owners and validate your approach.

Fork the repository and clone it.

Create your local branch, name it with issue number, for example for issue #321: $ git checkout -b 321-short-clear-name

Make changes in code, check linter and formatter warnings.

Note

While we don’t use ‘pre-commit’ as a Git hook, you should set up your IDE with linter and code formatter or use separate python packages for this.

We prefer ‘flake8’ as Linter and ‘black’ as Formatter.

Commit your changes (do a series of small, atomic commits documenting your steps).

Push your local branch.

Open a pull request to submit changes to this project.

Your pull request needs to meet the following guidelines for acceptance:

  • The Nox test suite must pass without errors and warnings.

  • Include unit tests. This project maintains 100% code coverage.

  • If your changes add functionality, update the documentation accordingly.

Feel free to submit early, though—we can always iterate on this.