blob: a81935d3c9da764d494956c5688fe03f7948c47d [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
Hai Shi2377a9b2020-05-26 03:19:42 +080011- 3.9
12
13 + `Stable buildbots <http://buildbot.python.org/3.9.stable/>`_
14
15- 3.8
16
17 + `Stable buildbots <http://buildbot.python.org/3.8.stable/>`_
18
Suriyaa ✌️️9e6685e2018-06-08 17:40:55 +020019- 3.7
20
21 + `Stable buildbots <http://buildbot.python.org/3.7.stable/>`_
22
Brett Cannon0c719822017-02-10 14:08:55 -080023
Brett Cannon5df8c582017-08-22 13:06:50 -070024Thank You
25---------
26First off, thanks for contributing to the maintenance of the Python programming
27language and the CPython interpreter! Even if your contribution is not
28ultimately accepted, the fact you put time and effort into helping out is
29greatly appreciated.
30
31
Brett Cannon0c719822017-02-10 14:08:55 -080032Contribution Guidelines
33-----------------------
Brett Cannon5df8c582017-08-22 13:06:50 -070034Please read the `devguide <https://devguide.python.org/>`_ for
Brett Cannon0c719822017-02-10 14:08:55 -080035guidance on how to contribute to this project. The documentation covers
36everything from how to build the code to submitting a pull request. There are
37also suggestions on how you can most effectively help the project.
38
39Please be aware that our workflow does deviate slightly from the typical GitHub
Brett Cannon1e5766f2017-03-31 14:19:04 -070040project. Details on how to properly submit a pull request are covered in
Brett Cannon5df8c582017-08-22 13:06:50 -070041`Lifecycle of a Pull Request <https://devguide.python.org/pullrequest/>`_.
42We utilize various bots and status checks to help with this, so do follow the
43comments they leave and their "Details" links, respectively. The key points of
44our workflow that are not covered by a bot or status check are:
Brett Cannon0c719822017-02-10 14:08:55 -080045
Brett Cannon5df8c582017-08-22 13:06:50 -070046- All discussions that are not directly related to the code in the pull request
47 should happen on bugs.python.org
48- Upon your first non-trivial pull request (which includes documentation changes),
49 feel free to add yourself to ``Misc/ACKS``
50
51
52Setting Expectations
53--------------------
54Due to the fact that this project is entirely volunteer-run (i.e. no one is paid
55to work on Python full-time), we unfortunately can make no guarantees as to if
56or when a core developer will get around to reviewing your pull request.
57If no core developer has done a review or responded to changes made because of a
58"changes requested" review, please feel free to email python-dev to ask if
59someone could take a look at your pull request.
Brett Cannon0c719822017-02-10 14:08:55 -080060
61
62Code of Conduct
63---------------
64All interactions for this project are covered by the
65`PSF Code of Conduct <https://www.python.org/psf/codeofconduct/>`_. Everyone is
66expected to be open, considerate, and respectful of others no matter their
67position within the project.