Brett Cannon | 0c71982 | 2017-02-10 14:08:55 -0800 | [diff] [blame] | 1 | Contributing to Python |
| 2 | ====================== |
| 3 | |
| 4 | Build Status |
| 5 | ------------ |
| 6 | |
| 7 | - master |
| 8 | |
Brett Cannon | 0c71982 | 2017-02-10 14:08:55 -0800 | [diff] [blame] | 9 | + `Stable buildbots <http://buildbot.python.org/3.x.stable/>`_ |
| 10 | |
| 11 | - 3.6 |
| 12 | |
| 13 | + `Stable buildbots <http://buildbot.python.org/3.6.stable/>`_ |
| 14 | |
Brett Cannon | 0c71982 | 2017-02-10 14:08:55 -0800 | [diff] [blame] | 15 | - 2.7 |
| 16 | |
| 17 | + `Stable buildbots <http://buildbot.python.org/2.7.stable/>`_ |
| 18 | |
| 19 | |
Brett Cannon | 5df8c58 | 2017-08-22 13:06:50 -0700 | [diff] [blame] | 20 | Thank You |
| 21 | --------- |
| 22 | First off, thanks for contributing to the maintenance of the Python programming |
| 23 | language and the CPython interpreter! Even if your contribution is not |
| 24 | ultimately accepted, the fact you put time and effort into helping out is |
| 25 | greatly appreciated. |
| 26 | |
| 27 | |
Brett Cannon | 0c71982 | 2017-02-10 14:08:55 -0800 | [diff] [blame] | 28 | Contribution Guidelines |
| 29 | ----------------------- |
Brett Cannon | 5df8c58 | 2017-08-22 13:06:50 -0700 | [diff] [blame] | 30 | Please read the `devguide <https://devguide.python.org/>`_ for |
Brett Cannon | 0c71982 | 2017-02-10 14:08:55 -0800 | [diff] [blame] | 31 | guidance on how to contribute to this project. The documentation covers |
| 32 | everything from how to build the code to submitting a pull request. There are |
| 33 | also suggestions on how you can most effectively help the project. |
| 34 | |
| 35 | Please be aware that our workflow does deviate slightly from the typical GitHub |
Brett Cannon | 1e5766f | 2017-03-31 14:19:04 -0700 | [diff] [blame] | 36 | project. Details on how to properly submit a pull request are covered in |
Brett Cannon | 5df8c58 | 2017-08-22 13:06:50 -0700 | [diff] [blame] | 37 | `Lifecycle of a Pull Request <https://devguide.python.org/pullrequest/>`_. |
| 38 | We utilize various bots and status checks to help with this, so do follow the |
| 39 | comments they leave and their "Details" links, respectively. The key points of |
| 40 | our workflow that are not covered by a bot or status check are: |
Brett Cannon | 0c71982 | 2017-02-10 14:08:55 -0800 | [diff] [blame] | 41 | |
Brett Cannon | 5df8c58 | 2017-08-22 13:06:50 -0700 | [diff] [blame] | 42 | - All discussions that are not directly related to the code in the pull request |
| 43 | should happen on bugs.python.org |
| 44 | - Upon your first non-trivial pull request (which includes documentation changes), |
| 45 | feel free to add yourself to ``Misc/ACKS`` |
| 46 | |
| 47 | |
| 48 | Setting Expectations |
| 49 | -------------------- |
| 50 | Due to the fact that this project is entirely volunteer-run (i.e. no one is paid |
| 51 | to work on Python full-time), we unfortunately can make no guarantees as to if |
| 52 | or when a core developer will get around to reviewing your pull request. |
| 53 | If no core developer has done a review or responded to changes made because of a |
| 54 | "changes requested" review, please feel free to email python-dev to ask if |
| 55 | someone could take a look at your pull request. |
Brett Cannon | 0c71982 | 2017-02-10 14:08:55 -0800 | [diff] [blame] | 56 | |
| 57 | |
| 58 | Code of Conduct |
| 59 | --------------- |
| 60 | All interactions for this project are covered by the |
| 61 | `PSF Code of Conduct <https://www.python.org/psf/codeofconduct/>`_. Everyone is |
| 62 | expected to be open, considerate, and respectful of others no matter their |
| 63 | position within the project. |