2017-02-10 22:08:55 +00:00
|
|
|
Contributing to Python
|
|
|
|
|
======================
|
|
|
|
|
|
|
|
|
|
Build Status
|
|
|
|
|
------------
|
|
|
|
|
|
2022-10-25 17:13:37 +00:00
|
|
|
- `Buildbot status overview <https://buildbot.python.org/all/#/release_status>`_
|
2017-02-10 22:08:55 +00:00
|
|
|
|
2022-10-25 17:13:37 +00:00
|
|
|
- `GitHub Actions status <https://github.com/python/cpython/actions/workflows/build.yml>`_
|
2017-02-10 22:08:55 +00:00
|
|
|
|
|
|
|
|
|
2017-08-22 20:06:50 +00:00
|
|
|
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.
|
|
|
|
|
|
|
|
|
|
|
2017-02-10 22:08:55 +00:00
|
|
|
Contribution Guidelines
|
|
|
|
|
-----------------------
|
2017-08-22 20:06:50 +00:00
|
|
|
Please read the `devguide <https://devguide.python.org/>`_ for
|
2017-02-10 22:08:55 +00:00
|
|
|
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
|
2017-03-31 21:19:04 +00:00
|
|
|
project. Details on how to properly submit a pull request are covered in
|
2022-10-08 22:16:52 +00:00
|
|
|
`Lifecycle of a Pull Request <https://devguide.python.org/getting-started/pull-request-lifecycle.html>`_.
|
2017-08-22 20:06:50 +00:00
|
|
|
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
|
2022-04-10 22:03:27 +00:00
|
|
|
should happen on `GitHub Issues <https://github.com/python/cpython/issues>`_.
|
2017-08-22 20:06:50 +00:00
|
|
|
- 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.
|
2017-02-10 22:08:55 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
Code of Conduct
|
|
|
|
|
---------------
|
|
|
|
|
All interactions for this project are covered by the
|
|
|
|
|
`PSF Code of Conduct <https://www.python.org/psf/codeofconduct/>`_. Everyone is
|
|
|
|
|
expected to be open, considerate, and respectful of others no matter their
|
|
|
|
|
position within the project.
|
