aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMike Crute <mike@crute.us>2019-03-17 19:49:20 +0000
committerMike Crute <mike@crute.us>2019-03-17 19:49:22 +0000
commitd8f4719fd128478630f991d79e0ce13bf0739453 (patch)
treec353082978cbc10649e977ed3b2b4ac378675ddf
parente74d70a307c6722317fe35b5527991779e701956 (diff)
downloadpydora-d8f4719fd128478630f991d79e0ce13bf0739453.tar.bz2
pydora-d8f4719fd128478630f991d79e0ce13bf0739453.tar.xz
pydora-d8f4719fd128478630f991d79e0ce13bf0739453.zip
Split contributing to its own file
This is to make the GitHub community health check happier.
-rw-r--r--CONTRIBUTING.rst20
-rw-r--r--README.rst18
2 files changed, 21 insertions, 17 deletions
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
new file mode 100644
index 0000000..9d3de46
--- /dev/null
+++ b/CONTRIBUTING.rst
@@ -0,0 +1,20 @@
1============
2Contributing
3============
4If you would like to contribute to Pydora please visit the project's
5`GitHub page <https://github.com/mcrute/pydora>`_ and open a pull request with
6your changes. To have the best experience contributing, please:
7
8* Don't break backwards compatibility of public interfaces
9* Write tests for your new feature/bug fix
10* Ensure that existing tests pass
11* Update the readme/docstrings, if necessary
12* Follow the coding style of the current code-base
13* Ensure that your code is PEP8 compliant
14* Validate that your changes work with Python 2.7+ and 3.3+
15
16All code is reviewed before acceptance and changes may be requested to better
17follow the conventions of the existing API.
18
19The build system runs ``python setup.py validate`` on all supported Python
20versions. You can, and should, run this on your pull request before submitting.
diff --git a/README.rst b/README.rst
index 5da48e1..776d522 100644
--- a/README.rst
+++ b/README.rst
@@ -189,23 +189,7 @@ need to download the keys yourself you can find them at the link below.
189 189
190Contributing 190Contributing
191============ 191============
192If you would like to contribute to Pydora please visit the project's 192See `CONTRIBUTING <https://github.com/mcrute/pydora/blob/master/CONTRIBUTING.rst>`_
193`GitHub page <https://github.com/mcrute/pydora>`_ and open a pull request with
194your changes. To have the best experience contributing, please:
195
196* Don't break backwards compatibility of public interfaces
197* Write tests for your new feature/bug fix
198* Ensure that existing tests pass
199* Update the readme/docstrings, if necessary
200* Follow the coding style of the current code-base
201* Ensure that your code is PEP8 compliant
202* Validate that your changes work with Python 2.7+ and 3.3+
203
204All code is reviewed before acceptance and changes may be requested to better
205follow the conventions of the existing API.
206
207The build system runs ``python setup.py validate`` on all supported Python
208versions. You can, and should, run this on your pull request before submitting.
209 193
210Contributors 194Contributors
211============ 195============