aboutsummaryrefslogtreecommitdiff
path: root/README.rst
diff options
context:
space:
mode:
authorMike Crute <mcrute@gmail.com>2015-12-12 19:38:38 -0800
committerMike Crute <mcrute@gmail.com>2015-12-12 19:38:38 -0800
commit52596c47ae1a0459e3b4f0b3ab9379a8f4010954 (patch)
treec4a986c09902e0da56bc6ffe8ddbd33b0cb75173 /README.rst
parentd57c3def8bb24417ec6c806c03bc0bff42835377 (diff)
downloadpydora-52596c47ae1a0459e3b4f0b3ab9379a8f4010954.tar.bz2
pydora-52596c47ae1a0459e3b4f0b3ab9379a8f4010954.tar.xz
pydora-52596c47ae1a0459e3b4f0b3ab9379a8f4010954.zip
Add contributors and contribution guidelines
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst25
1 files changed, 25 insertions, 0 deletions
diff --git a/README.rst b/README.rst
index 7475d5f..1cedd95 100644
--- a/README.rst
+++ b/README.rst
@@ -87,3 +87,28 @@ need to download the keys yourself you can find them at the link below.
87 87
88* `API Spec <http://6xq.net/playground/pandora-apidoc/>`_ 88* `API Spec <http://6xq.net/playground/pandora-apidoc/>`_
89* `Partner Keys <http://6xq.net/playground/pandora-apidoc/json/partners/#partners>`_ 89* `Partner Keys <http://6xq.net/playground/pandora-apidoc/json/partners/#partners>`_
90
91Contributing
92============
93If you would like to contribute to Pydora please visit the project's
94`GitHub page <https://github.com/mcrute/pydora>`_ and open a pull request with
95your changes. To have the best experience contributing, please:
96
97* Don't break backwards compatibility of public interfaces
98* Write tests for your new feature/bug fix
99* Ensure that existing tests pass
100* Update the readme/docstrings, if necessary
101* Follow the coding style of the current code-base
102* Ensure that your code is PEP8 compliant
103* Validate that your changes work with Python 2.7+ and 3.x
104
105All code is reviewed before acceptance and changes may be requested to better
106follow the conventions of the existing API.
107
108he build system runs ``python setup.py validate`` on all supported Python
109versions. You can, and should, run this on your pull request before submitting.
110
111Contributors
112============
113* John Cass (`jcass77 <https://github.com/jcass77>`_)
114* Thomas Weißschuh (`t-8c <https://github.com/t-8ch>`_)