blob: d559bd5e189448ad740edf69fe4652e14e822a20 [file] [log] [blame]
Brett Cannon0c719822017-02-10 14:08:55 -08001Contributing to Python
2======================
3
4Build Status
5------------
6
7- master
8
Brett Cannon0c719822017-02-10 14:08:55 -08009 + `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 Cannon0c719822017-02-10 14:08:55 -080015- 2.7
16
17 + `Stable buildbots <http://buildbot.python.org/2.7.stable/>`_
18
19
Brett Cannon5df8c582017-08-22 13:06:50 -070020Thank You
21---------
22First off, thanks for contributing to the maintenance of the Python programming
23language and the CPython interpreter! Even if your contribution is not
24ultimately accepted, the fact you put time and effort into helping out is
25greatly appreciated.
26
27
Brett Cannon0c719822017-02-10 14:08:55 -080028Contribution Guidelines
29-----------------------
Brett Cannon5df8c582017-08-22 13:06:50 -070030Please read the `devguide <https://devguide.python.org/>`_ for
Brett Cannon0c719822017-02-10 14:08:55 -080031guidance on how to contribute to this project. The documentation covers
32everything from how to build the code to submitting a pull request. There are
33also suggestions on how you can most effectively help the project.
34
35Please be aware that our workflow does deviate slightly from the typical GitHub
Brett Cannon1e5766f2017-03-31 14:19:04 -070036project. Details on how to properly submit a pull request are covered in
Brett Cannon5df8c582017-08-22 13:06:50 -070037`Lifecycle of a Pull Request <https://devguide.python.org/pullrequest/>`_.
38We utilize various bots and status checks to help with this, so do follow the
39comments they leave and their "Details" links, respectively. The key points of
40our workflow that are not covered by a bot or status check are:
Brett Cannon0c719822017-02-10 14:08:55 -080041
Brett Cannon5df8c582017-08-22 13:06:50 -070042- 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
48Setting Expectations
49--------------------
50Due to the fact that this project is entirely volunteer-run (i.e. no one is paid
51to work on Python full-time), we unfortunately can make no guarantees as to if
52or when a core developer will get around to reviewing your pull request.
53If 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
55someone could take a look at your pull request.
Brett Cannon0c719822017-02-10 14:08:55 -080056
57
58Code of Conduct
59---------------
60All interactions for this project are covered by the
61`PSF Code of Conduct <https://www.python.org/psf/codeofconduct/>`_. Everyone is
62expected to be open, considerate, and respectful of others no matter their
63position within the project.