Contributing — python-rtmidi 1.5.8 documentation

# 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/SpotlightKid/python-rtmidi/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

Look through the GitHub issues for bugs. Anything tagged with “bug” is open to whoever wants to fix it.

### Implement Features

Look through the GitHub issues for features. Anything tagged with “feature” is open to whoever wants to implement it.

### Write Documentation

python-rtmidi could always use more documentation, whether as part of the official python-rtmidi 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/SpotlightKid/python-rtmidi/issues.

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 :)

## Get Started!

Ready to contribute? Here’s how to set up python-rtmidi for local development.

1. Fork the `python-rtmidi` repo on GitHub.

2. Clone your fork locally:

       $ git clone --recursive git@github.com:your_name_here/python-rtmidi.git

3. Install your local copy into a virtualenv. Assuming you have `virtualenvwrapper` installed, this is how you set up your fork for local development:

       $ mkvirtualenv python-rtmidi
       $ cd python-rtmidi/
       $ pip install -r requirements-dev.txt
       $ python -m pip install .

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, make sure that your changes pass the `flake8` checks and the unit tests, also testing other Python versions with `tox`:

       $ make lint
       $ make test

   `flake8` and `tox` shoudl have been installed via the requirements file used in the instructions above. Should you use a different setup, make sure you `pip install` them into your current Python environment.

6. Commit your changes and push your branch to GitHub:

       $ git add .
       $ git commit -m "Detailed description of your changes."
       $ git push -u origin name-of-your-bugfix-or-feature

7. 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 include tests.

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 release notes in `CHANGELOG.rst`.

3. The pull request should work for all supported Python 3 versions (see classifiers in `pyproject.toml`)

   Run `tox` to make sure that the tests pass for all supported Python versions.

## Tips

To run a subset of tests:

    $ py.test -v tests/test_foo.py::test_foo