From d8f4719fd128478630f991d79e0ce13bf0739453 Mon Sep 17 00:00:00 2001 From: Mike Crute Date: Sun, 17 Mar 2019 19:49:20 +0000 Subject: Split contributing to its own file This is to make the GitHub community health check happier. --- CONTRIBUTING.rst | 20 ++++++++++++++++++++ README.rst | 18 +----------------- 2 files changed, 21 insertions(+), 17 deletions(-) create mode 100644 CONTRIBUTING.rst diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst new file mode 100644 index 0000000..9d3de46 --- /dev/null +++ b/CONTRIBUTING.rst @@ -0,0 +1,20 @@ +============ +Contributing +============ +If you would like to contribute to Pydora please visit the project's +`GitHub page `_ and open a pull request with +your changes. To have the best experience contributing, please: + +* Don't break backwards compatibility of public interfaces +* Write tests for your new feature/bug fix +* Ensure that existing tests pass +* Update the readme/docstrings, if necessary +* Follow the coding style of the current code-base +* Ensure that your code is PEP8 compliant +* Validate that your changes work with Python 2.7+ and 3.3+ + +All code is reviewed before acceptance and changes may be requested to better +follow the conventions of the existing API. + +The build system runs ``python setup.py validate`` on all supported Python +versions. 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. Contributing ============ -If you would like to contribute to Pydora please visit the project's -`GitHub page `_ and open a pull request with -your changes. To have the best experience contributing, please: - -* Don't break backwards compatibility of public interfaces -* Write tests for your new feature/bug fix -* Ensure that existing tests pass -* Update the readme/docstrings, if necessary -* Follow the coding style of the current code-base -* Ensure that your code is PEP8 compliant -* Validate that your changes work with Python 2.7+ and 3.3+ - -All code is reviewed before acceptance and changes may be requested to better -follow the conventions of the existing API. - -The build system runs ``python setup.py validate`` on all supported Python -versions. You can, and should, run this on your pull request before submitting. +See `CONTRIBUTING `_ Contributors ============ -- cgit v1.2.3