Skip to content

Commit

Permalink
Touch up the contributing notes (python#3158)
Browse files Browse the repository at this point in the history
* Mention how to find out what to do
* Update URL
* Thanks contributors
* Explain there is no timeline
  • Loading branch information
brettcannon authored and ambv committed Aug 22, 2017
1 parent 41bbd82 commit 5df8c58
Showing 1 changed file with 28 additions and 12 deletions.
40 changes: 28 additions & 12 deletions .github/CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 5df8c58

Please sign in to comment.