summaryrefslogtreecommitdiff
path: root/.github
diff options
context:
space:
mode:
authorBrett Cannon <brettcannon@users.noreply.github.com>2017-08-22 13:06:50 -0700
committerƁukasz Langa <lukasz@langa.pl>2017-08-22 13:06:50 -0700
commit5df8c589f4ec3d8c1ccd115dc030fa7596c1c75d (patch)
tree0926e32f9a640f6430241707b6612b0f63d5e9c1 /.github
parent41bbd82b6b6a887e893974fa5cdaae7782ae6cac (diff)
downloadcpython-git-5df8c589f4ec3d8c1ccd115dc030fa7596c1c75d.tar.gz
Touch up the contributing notes (#3158)
* Mention how to find out what to do * Update URL * Thanks contributors * Explain there is no timeline
Diffstat (limited to '.github')
-rw-r--r--.github/CONTRIBUTING.rst40
1 files changed, 28 insertions, 12 deletions
diff --git a/.github/CONTRIBUTING.rst b/.github/CONTRIBUTING.rst
index 83cfee34b4..d559bd5e18 100644
--- a/.github/CONTRIBUTING.rst
+++ b/.github/CONTRIBUTING.rst
@@ -12,31 +12,47 @@ Build Status
+ `Stable buildbots <http://buildbot.python.org/3.6.stable/>`_
-- 3.5
-
- + `Stable buildbots <http://buildbot.python.org/3.5.stable/>`_
-
- 2.7
+ `Stable buildbots <http://buildbot.python.org/2.7.stable/>`_
+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 <https://cpython-devguide.readthedocs.io/>`_ for
+Please read the `devguide <https://devguide.python.org/>`_ 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 <https://cpython-devguide.readthedocs.io/pullrequest.html>`_.
-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.
-
-If you are making a code contribution or large documentation contribution,
-please feel free to add yourself to the ``Misc/ACKS`` file alphabetically.
+`Lifecycle of a Pull Request <https://devguide.python.org/pullrequest/>`_.
+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:
+
+- 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