From 5df8c589f4ec3d8c1ccd115dc030fa7596c1c75d Mon Sep 17 00:00:00 2001 From: Brett Cannon Date: Tue, 22 Aug 2017 13:06:50 -0700 Subject: [PATCH] Touch up the contributing notes (#3158) * Mention how to find out what to do * Update URL * Thanks contributors * Explain there is no timeline --- .github/CONTRIBUTING.rst | 38 +++++++++++++++++++++++++++----------- 1 file changed, 27 insertions(+), 11 deletions(-) diff --git a/.github/CONTRIBUTING.rst b/.github/CONTRIBUTING.rst index 83cfee34b45..d559bd5e189 100644 --- a/.github/CONTRIBUTING.rst +++ b/.github/CONTRIBUTING.rst @@ -12,31 +12,47 @@ Build Status + `Stable buildbots `_ -- 3.5 - - + `Stable buildbots `_ - - 2.7 + `Stable buildbots `_ +Thank You +--------- +First off, thanks for contributing to the maintenance of the Python programming +language and the CPython interpreter! Even if your contribution is not +ultimately accepted, the fact you put time and effort into helping out is +greatly appreciated. + + Contribution Guidelines ----------------------- -Please read the `devguide `_ for +Please read the `devguide `_ for guidance on how to contribute to this project. The documentation covers everything from how to build the code to submitting a pull request. There are also suggestions on how you can most effectively help the project. Please be aware that our workflow does deviate slightly from the typical GitHub project. Details on how to properly submit a pull request are covered in -`Lifecycle of a Pull Request `_. -One key point is to keep comments on GitHub to only those related to the reviewing -the code in the pull request. All other discussions -- e.g. about the issue being -fixed -- should happen on bugs.python.org. +`Lifecycle of a Pull Request `_. +We utilize various bots and status checks to help with this, so do follow the +comments they leave and their "Details" links, respectively. The key points of +our workflow that are not covered by a bot or status check are: -If you are making a code contribution or large documentation contribution, -please feel free to add yourself to the ``Misc/ACKS`` file alphabetically. +- All discussions that are not directly related to the code in the pull request + should happen on bugs.python.org +- Upon your first non-trivial pull request (which includes documentation changes), + feel free to add yourself to ``Misc/ACKS`` + + +Setting Expectations +-------------------- +Due to the fact that this project is entirely volunteer-run (i.e. no one is paid +to work on Python full-time), we unfortunately can make no guarantees as to if +or when a core developer will get around to reviewing your pull request. +If no core developer has done a review or responded to changes made because of a +"changes requested" review, please feel free to email python-dev to ask if +someone could take a look at your pull request. Code of Conduct