Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
56 lines (35 loc) · 2.28 KB

CONTRIBUTING.md

File metadata and controls

56 lines (35 loc) · 2.28 KB
Raw

Contributing to the Spotify Popularity Project

All types of contributions to the Spotify Popularity project are welcome and greatly appreciated! Every little bit helps, and credit will always be given. If you encounter a bug or have an idea for a new feature, we encourage you to share by opening an issue here. If you're inclined to improve the project by adding a feature or fixing a bug, you can fork our repository and propose your changes via a pull request.

Types of Contributions

Report Bugs

If you are reporting a bug, please include:

  • Your operating system name and version.
  • 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" and "help wanted" is open to whoever wants to implement it.

Implement Features

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

Write Documentation

You can never have enough documentation! Please feel free to contribute to any part of the documentation, such as the official docs, docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback

If you are proposing a feature:

  • Explain in detail 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 :)

Pull Request Guidelines

Before you submit a pull request, check that it meets these guidelines:

  1. The pull request should include additional tests if appropriate.
  2. If the pull request adds functionality, the docs should be updated.
  3. The pull request should work for all currently supported operating systems and versions of Python.

Code of Conduct

Please note that the spotify-popularity project is released with a Code of Conduct. By contributing to this project you agree to abide by its terms.

Attribution

This CONTRIBUTING.md is adapted from py-pkgs-cookiecutter.