1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
|
============
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
|
