Skip to content

Latest commit

 

History

History
82 lines (48 loc) · 2.07 KB

CONTRIBUTING.rst

File metadata and controls

82 lines (48 loc) · 2.07 KB
Raw

Contributing

We greatly appreciate contributions!

There are many ways to contribute.

Types of Contributions

Submitting Issues

Please submit issues in the issue tracker.

Fix Bugs

Look through the GitHub issues for issues tagged with "bug".

Implement Features

Look through the GitHub issues for issues tagged with "enhancement".

Write Documentation

Documentation improvements are always welcome.

Types of documentation:

  • README file improvements
  • Improved docstrings
  • Sphinx documentation (this is missing currently)
  • FAQ/help page or website copy improvements

Start Contributing

Here's how to setup the Free Music Ninja website for local development:

  1. Fork the repository on GitHub with the "Fork" button and clone it locally. Fork instructions.
  2. Follow the setup instructions in the README file.
  3. Create a branch for development of your bug/feature/improvement:
$ git checkout -b name-of-bug-or-feature
  1. When you have some changes committed, push your code:
$ git push -u origin HEAD
  1. Open a pull request on GitHub.

Pull Request Guidelines

Please try to conform to PEP8 for code contributions and ensure that the tests continue to function.

Please include new tests with your pull requests when appropriate.

Feel free to open pull requests before you've finished your code or tests. Opening your pull request sooner will allow others to comment on it sooner. Please note the status of your pull request when submitting it and update the status as appropriate.

When submitting a pull request, please make sure to:

  • Write tests if applicable
  • Note important changes in the CHANGES.rst file
  • Update the documentation if needed
  • Add yourself to the AUTHORS.rst file