Skip to content
Merged
9 changes: 3 additions & 6 deletions .github/CODE_OF_CONDUCT.rst → .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,10 @@
:orphan:

Code of Conduct
===============

Please note that all interactions on
`Python Software Foundation <https://www.python.org/psf-landing/>`__-supported
infrastructure is `covered
<https://www.python.org/psf/records/board/minutes/2014-01-06/#management-of-the-psfs-web-properties>`__
by the `PSF Code of Conduct <https://www.python.org/psf/codeofconduct/>`__,
[Python Software Foundation](https://www.python.org/psf-landing/)-supported
infrastructure is [covered](https://www.python.org/psf/records/board/minutes/2014-01-06/#management-of-the-psfs-web-properties)
by the [PSF Code of Conduct](https://www.python.org/psf/codeofconduct/),
which includes all infrastructure used in the development of Python itself
(e.g. mailing lists, issue trackers, GitHub, etc.).

Expand Down
45 changes: 45 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# Contributing to the Devguide

## Thank You

First off, thanks for contributing to the devguide of the Python programming
language! 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 this [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://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`](https://github.com/python/cpython/blob/master/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

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.
11 changes: 11 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!--
Thanks for your contribution!
Please read this comment in its entirety. It's quite important.

# Pull Request title

It should describe the change to be made.

Most PRs will require an issue number. Trivial changes, like fixing a typo,
do not need an issue.
-->
2 changes: 1 addition & 1 deletion conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = ['_build', 'venv*', 'env*', 'README.rst']
exclude_patterns = ['_build', 'venv*', 'env*', 'README.rst', '.github']

# The reST default role (used for this markup: `text`) to use for all documents.
#default_role = None
Expand Down