Skip to content

Latest commit

 

History

History
112 lines (70 loc) · 3.16 KB

CONTRIBUTING.rst

File metadata and controls

112 lines (70 loc) · 3.16 KB
Raw

Contributing

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

You can contribute in many ways:

Types of Contributions

Report Bugs

Report bugs at https://github.com/wearpants/playerpiano/issues

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 & Implement Features

Look through the GitHub issues for bugs & enhancements. Anything tagged "help wanted" is a good place to start. If you'd like to work on a different issue, don't hesitate to ask!

Write Documentation

Instrument could always use more documentation, whether as part of the official docs, in docstrings, or even on the web in blog posts, articles, and such.

Submit Feedback

The best way to send feedback is to file an issue at https://github.com/playerpiano/wearpants/issues.

If you are proposing a new 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 :)

Get Started!

Ready to contribute? Here's how to set up playerpiano for local development. Please note this documentation assumes you already have virtualenv and Git installed and ready to go.

  1. Fork the playerpiano repo on GitHub.
  2. Clone your fork locally:
$ cd path_for_the_repo
$ git clone [email protected]:YOUR_NAME/playerpiano.git
  1. Assuming you have virtualenv installed (If you have Python3.5 this should already be there), you can create a new environment for your local development by typing:
$ virtualenv playerpiano-env
$ source playerpiano-env/bin/activate

This should change the shell to look something like
(playerpiano-env) $
  1. Create a branch for local development:
 $ git checkout -b name-of-your-bugfix-or-feature

Now you can make your changes locally.
  1. When you're done making changes, check that your changes pass flake8:
$ flake8
  1. Commit your changes and push your branch to GitHub:
$ git add .
$ git commit -m "Your detailed description of your changes."
$ git push origin name-of-your-bugfix-or-feature
  1. Submit a pull request through the GitHub website.

Pull Request Guidelines

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

  1. The pull request should be tested.
  2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
  3. The pull request should work for Python 2.7 and 3.