8000 Add contributing, issue/pr templates, and reformat CoC (#482) · python/devguide@87b6548 · GitHub
[go: up one dir, main page]
Skip to content

Commit 87b6548

Browse files
willingcwillingc
authored
Add contributing, issue/pr templates, and reformat CoC (#482)
* Convert CoC to markdown for GH insights * Add contributing file * add PR template * add issue template * add an issue template and format * add .github directory to sphinx exclude * add link * update link and text * update link * remove old style issue template * add ignore .github to conf exclude directory * make contributing markdown to conform to github community standard * correct link style * convert to md
1 parent dcb8ec2 commit 87b6548

File tree

4 files changed

+60
-7
lines changed

4 files changed

+60
-7
lines changed

‎.github/CODE_OF_CONDUCT.rst renamed to ‎.github/CODE_OF_CONDUCT.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,10 @@
1-
:orphan:
2-
31
Code of Conduct
42
===============
53

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

‎.github/CONTRIBUTING.md

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# Contributing to the Devguide
2+
3+
## Thank You
4+
5+
First off, thanks for contributing to the devguide of the Python programming
6+
language! Even if your contribution is not ultimately accepted, the fact you
7+
put time and effort into helping out is greatly appreciated.
8+
9+
10+
## Contribution Guidelines
11+
12+
Please read this [devguide](https://devguide.python.org/) for
13+
guidance on how to contribute to this project. The documentation covers
14+
everything from how to build the code to submitting a pull request. There are
15+
also suggestions on how you can most effectively help the project.
16+
17+
Please be aware that our workflow does deviate slightly from the typical GitHub
18+
project. Details on how to properly submit a pull request are covered in
19+
[Lifecycle of a Pull Request](https://devguide.python.org/pullrequest/).
20+
We utilize various bots and status checks to help with this, so do follow the
21+
comments they leave and their "Details" links, respectively. The key points of
22+
our workflow that are not covered by a bot or status check are:
23+
24+
- All discussions that are not directly related to the code in the pull request
25+
should happen on bugs.python.org
26+
- Upon your first non-trivial pull request (which includes documentation changes),
27+
feel free to add yourself to [`Misc/ACKS`](https://github.com/python/cpython/blob/master/Misc/ACKS)
28+
29+
30+
## Setting Expectations
31+
32+
Due to the fact that this project is entirely volunteer-run (i.e. no one is paid
33+
to work on Python full-time), we unfortunately can make no guarantees as to if
34+
or when a core developer will get around to reviewing your pull request.
35+
If no core developer has done a review or responded to changes made because of a
36+
"changes requested" review, please feel free to email python-dev to ask if
37+
someone could take a look at your pull request.
38+
39+
40+
## Code of Conduct
41+
42+
All interactions for this project are covered by the
43+
[PSF Code of Conduct](https://www.python.org/psf/codeofconduct/). Everyone is
44+
expected to be open, considerate, and respectful of others no matter their
45+
position within the project.

‎.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<!--
2+
Thanks for your contribution!
3+
Please read this comment in its entirety. It's quite important.
4+
5+
# Pull Request title
6+
7+
It should describe the change to be made.
8+
9+
Most PRs will require an issue number. Trivial changes, like fixing a typo,
10+
do not need an issue.
11+
-->

‎conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@
6767

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

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

0 commit comments

Comments
 (0)
0