Skip to content

Latest commit

 

History

History
67 lines (47 loc) · 2.56 KB

CONTRIBUTING.md

File metadata and controls

67 lines (47 loc) · 2.56 KB
Raw

Contributing to SoundCloud Downloader

Thank you for considering contributing to SoundCloud Downloader

Table of Contents

  1. How Can I Contribute?
  2. Style Guidelines
  3. Commit Messages
  4. Pull Requests

How Can I Contribute?

Reporting Bugs

  • Before submitting a bug report, please check the existing issues to avoid duplicates.
  • When filing an issue, make sure to answer these questions:
  1. What version of the project are you using?
  2. What operating system and processor architecture are you using?
  3. What did you do?
  4. What did you expect to see?
  5. What did you see instead?

Pull Requests

When creating your pull request, please include:

  1. A clear and descriptive title.
  2. A detailed description of the changes, including:
  • The motivation for the changes.
  • A summary of what has changed.
  • Any potential side effects or areas that might be affected.
  1. If applicable, include screenshots or animated GIFs demonstrating the changes.
  2. Reference any related issues using the GitHub issue linking syntax (e.g., "Fixes #123" or "Relates to #456").

Pull Request Process

  1. A project maintainer will review your pull request.
  2. They may ask for changes or clarifications in the comments.
  3. Make any requested changes by pushing new commits to your branch. The PR will update automatically.
  4. Once the maintainer is satisfied, they will approve and merge your pull request.
  • Keep your pull requests focused on a single issue or feature. If you have multiple unrelated changes, submit them as separate pull requests.
  • If your pull request is large or complex, consider breaking it into smaller, more manageable pieces.
  • Be responsive to comments and feedback on your pull request.
  • Be patient. The maintainers are likely volunteers and may not be able to review your contribution immediately.
  • If your pull request has conflicts with the base branch, rebase your branch onto the latest main branch.

Style Guidelines

Python Style Guide

This project follows the PEP 8 style guide. Please ensure your code adheres to these guidelines.

Documentation Style Guide

  • Use Markdown for documentation.
  • Keep language clear and concise.

Commit Messages

  • Use the present tense ("Add feature" not "Added feature")
  • Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
  • Limit the first line to 72 characters or less
  • Reference issues and pull requests liberally after the first line

Thank you for your contributions!