diff options
-rw-r--r-- | CONTRIBUTING.rst | 20 | ||||
-rw-r--r-- | README.rst | 18 |
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 | ============ | ||
2 | Contributing | ||
3 | ============ | ||
4 | If 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 | ||
6 | your 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 | |||
16 | All code is reviewed before acceptance and changes may be requested to better | ||
17 | follow the conventions of the existing API. | ||
18 | |||
19 | The build system runs ``python setup.py validate`` on all supported Python | ||
20 | versions. You can, and should, run this on your pull request before submitting. | ||
@@ -189,23 +189,7 @@ need to download the keys yourself you can find them at the link below. | |||
189 | 189 | ||
190 | Contributing | 190 | Contributing |
191 | ============ | 191 | ============ |
192 | If you would like to contribute to Pydora please visit the project's | 192 | See `CONTRIBUTING <https://github.com/mcrute/pydora/blob/master/CONTRIBUTING.rst>`_ |
193 | `GitHub page <https://github.com/mcrute/pydora>`_ and open a pull request with | ||
194 | your 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 | |||
204 | All code is reviewed before acceptance and changes may be requested to better | ||
205 | follow the conventions of the existing API. | ||
206 | |||
207 | The build system runs ``python setup.py validate`` on all supported Python | ||
208 | versions. You can, and should, run this on your pull request before submitting. | ||
209 | 193 | ||
210 | Contributors | 194 | Contributors |
211 | ============ | 195 | ============ |