summaryrefslogtreecommitdiff
path: root/.github/CONTRIBUTING.rst
diff options
context:
space:
mode:
authorBrett Cannon <brettcannon@users.noreply.github.com>2017-02-10 14:08:55 -0800
committerGitHub <noreply@github.com>2017-02-10 14:08:55 -0800
commit0c719824decc0c6d7365bcc1a4eb1b8f077f86c3 (patch)
tree241542fc46c8e3834b69a1ee3eaa36a1d6c48fcf /.github/CONTRIBUTING.rst
parentd2306cec4dc393a106aaac6b7c71a9b241be230d (diff)
downloadcpython-git-0c719824decc0c6d7365bcc1a4eb1b8f077f86c3.tar.gz
Add a CONTRIBUTING file
This file will be displayed to contributors when they create a pull request in any branch (hence why it is not written in a branch-specific way).
Diffstat (limited to '.github/CONTRIBUTING.rst')
-rw-r--r--.github/CONTRIBUTING.rst46
1 files changed, 46 insertions, 0 deletions
diff --git a/.github/CONTRIBUTING.rst b/.github/CONTRIBUTING.rst
new file mode 100644
index 0000000000..c64187b32c
--- /dev/null
+++ b/.github/CONTRIBUTING.rst
@@ -0,0 +1,46 @@
+Contributing to Python
+======================
+
+Build Status
+------------
+
+- master
+
+ + `Stable buildbots <http://buildbot.python.org/3.x.stable/>`_
+
+- 3.6
+
+ + `Stable buildbots <http://buildbot.python.org/3.6.stable/>`_
+
+- 3.5
+
+ + `Stable buildbots <http://buildbot.python.org/3.5.stable/>`_
+
+- 2.7
+
+ + `Stable buildbots <http://buildbot.python.org/2.7.stable/>`_
+
+
+Contribution Guidelines
+-----------------------
+Please read the `devguide <https://cpython-devguide.readthedocs.io/>`_ 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. Issues are tracked at https://bugs.python.org/ and should be mentioned
+in pull requests using the format of ``bpo-12345`` . If your pull request is in
+response to a specific issue then please mention it in the title,
+e.g. “bpo-12345: fix comment in tokenizer.c”.
+
+If you are making a code contribution or large documentation contribution,
+please feel free to add yourself to the ``Misc/ACKS`` file alphabetically.
+
+
+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.