Skip to content

Latest commit

 

History

History
116 lines (70 loc) · 4.43 KB

CONTRIBUTING.md

File metadata and controls

116 lines (70 loc) · 4.43 KB
Raw

Contributing

Contributions are welcome, and they are greatly appreciated! Every little helps, and credit will always be given.

You can contribute in many ways:

Types of Contributions

Report Bugs

Report bugs on our issues page. If you are reporting a bug, please include:

  • Any details about your local setup that might be helpful in troubleshooting.
  • Detailed steps to reproduce the bug.

Fix Bugs

Look through the GitHub issues for bugs. Anything tagged with "bug" is open to whoever wants to implement it.

Implement Features

Look through the GitHub issues for features. Anything tagged with "enhancement" is open to whoever wants to implement it.

Write Documentation

This module could always use more documentation, whether as part of the official docs, in docstrings, or other.

Submit Feedback

The best way to send feedback is to file a ticket on our issues page. If you are proposing a feature:

  • Explain how it would work.
  • Keep the scope as narrow as possible, to make it easier to implement.
  • Remember that this is a volunteer-driven project, and that contributions are welcome 🙂

Get Started!

Ready to contribute? Here's how to set up deezer-python for local development.

  1. Fork the repo on GitHub.

  2. Clone your fork locally:

    $ git clone [email protected]:your_name_here/deezer-python.git

  3. Install the dependencies with Poetry

    $ poetry install -E docs

  4. Create a branch for local development:

    $ git checkout -b name-of-your-bugfix-or-feature

    Now you can make your changes locally.

  5. When you're done making changes, check that your changes pass our tests:

    $ poetry run pytest

  6. Linting is done through pre-commit. Provided you have the tool installed globally, you can run them all as one-off:

    $ pre-commit run -a

    Or better, install the hooks once and have them run automatically each time you commit:

    $ pre-commit install

  7. Commit your changes, quoting GitHub issue in the commit message, if applicable, and push your branch to GitHub:

    $ git add .
$ git commit -m "feat(something): your detailed description of your changes"
$ git push origin name-of-your-bugfix-or-feature

    Note: the commit message should follow the conventional commits. We run commitlint on CI to validate it, and if you've installed pre-commit hooks at the previous step, the message will be checked at commit time.

  8. Submit a pull request on GitHub.

Obtain an API token

If you want to work on a feature that requires authentication, you'll need to obtain an API token to perform authenticated requests. You can do so using the deezer-oauth-cli package. It's a development dependency, so if you ran poetry install, you should already have it.

You'll need to have a dedicated app in the Deezer developer portal, create one with the following redirect URL after authentication: http://localhost:8080/oauth/return. Once created, grab the application ID and the secret key and call the CLI tool with them:

$ deezer-oauth APP_ID SECRET_KEY

Authorise the app in your browser. You should then should be redirected to a simple HTML page with your API token. The script also save the API token locally in the .env file. This is convenient to generate cassettes when writing new tests locally.

Pull Request Guidelines

Feel free to open the pull request as soon as possible, but please be explicit if it's still a work in progress, we recommend draft pull requests. Please try to:

  1. Include tests for feature or bug fixes.
  2. Update the documentation if for any significant API changes.
  3. Ensure tests are passing on continuous integration.

Create a New Release

The deployment should be automated and can be triggered from the Semantic Release workflow in GitHub. The next version will be based on the commit logs. This is done by python-semantic-release via a GitHub action.