8000 Meta: Add templates/checklists for new, Accepted/Rejected & Final PEP… · python/peps@f009036 · GitHub
[go: up one dir, main page]
Skip to content

Commit f009036

Browse files
CAM-Gerlachencukouhugovk
authored
Meta: Add templates/checklists for new, Accepted/Rejected & Final PEPs (#2956)
Co-authored-by: Petr Viktorin <encukou@gmail.com> Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
1 parent c36b348 commit f009036

File tree

6 files changed

+117
-11
lines changed

6 files changed

+117
-11
lines changed

‎.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 0 additions & 11 deletions
This file was deleted.

‎.github/PULL_REQUEST_TEMPLATE/accept-reject-pep.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
name: Accept/Reject PEP
3+
about: Mark a draft Standards Track PEP as accepted or rejected
4+
title: "PEP NNN: Mark as Accepted"
5+
---
6+
7+
# Accept/Reject PEP
8+
9+
<!--
10+
You can help complete the following checklist yourself if you like
11+
by ticking any boxes you're sure about, like this: [x]
12+
13+
If you're unsure about anything, just leave it blank and we'll take a look.
14+
-->
15+
16+
* [ ] SC/PEP Delegate has formally accepted/rejected the PEP and posted to the ``Discussions-To`` thread
17+
* [ ] Pull request title in appropriate format (``PEP 123: Mark as Accepted``)
18+
* [ ] ``Status`` changed to ``Accepted``/``Rejected``
19+
* [ ] ``Resolution`` link points directly to SC/PEP Delegate official acceptance/rejected post
20+
* [ ] Acceptance/rejection notice added, if the SC/PEP delegate had major conditions or comments
21+
* [ ] ``Discussions-To``, ``Post-History`` and ``Python-Version`` up to date

‎.github/PULL_REQUEST_TEMPLATE/mark-pep-final.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Mark PEP Final
3+
about: Mark an Accepted Standards Track PEP as Final
4+
title: "PEP NNN: Mark Final"
5+
---
6+
7+
# Mark PEP Final
8+
9+
<!--
10+
You can help complete the following checklist yourself if you like
11+
by ticking any boxes you're sure about, like this: [x]
12+
If you're unsure about something, just leave it blank and we'll take a look.
13+
-->
14+
15+
* [ ] Final implementation has been merged (including tests and docs)
16+
* [ ] PEP matches the final implementation
17+
* [ ] Any substantial changes since the accepted version approved by the SC/PEP delegate
18+
* [ ] Pull request title in appropriate format (``PEP 123: Mark Final``)
19+
* [ ] ``Status`` changed to ``Final`` (and ``Python-Version`` is correct)
20+
* [ ] Canonical docs/spec linked with a ``canonical-doc`` directive (or ``pypa-spec``, for packaging PEPs)

‎.github/PULL_REQUEST_TEMPLATE/modify-pep.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
name: Update/modify PEP
3+
about: Add to or change an existing PEP
4+
title: "PEP NNN: Description of change"
5+
---
6+
7+
<!--
8+
**Please** read our Contributing Guidelines (CONTRIBUTING.rst)
9+
to make sure this repo is the right place for your proposed change. Thanks!
10+
-->
11+
12+
* Change is either:
13+
* [ ] To a Draft PEP
14+
* [ ] To an Accepted or Final PEP, with Steering Council approval
15+
* [ ] To fix an editorial issue (markup, typo, link, header, etc)
16+
* [ ] PR title prefixed with PEP number (e.g. ``PEP 123: Summary of changes``)

‎.github/PULL_REQUEST_TEMPLATE/new-pep.md

Lines changed: 51 additions & 0 deletions
< 8000 td data-grid-cell-id="diff-a2b524d186ab77932c8aa601600b7f001b44f5b9c1ab956250ab299142f59ae8-empty-2-2" data-line-anchor="diff-a2b524d186ab77932c8aa601600b7f001b44f5b9c1ab956250ab299142f59ae8R2" data-selected="false" role="gridcell" style="background-color:var(--diffBlob-additionLine-bgColor, var(--diffBlob-addition-bgColor-line));padding-right:24px" tabindex="-1" valign="top" class="focusable-grid-cell diff-text-cell right-side-diff-cell left-side">+
name: New PEP
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
---
2
3+
about: Submit a new draft PEP
4+
title: "PEP NNN: Title of PEP"
5+
labels: "new-pep"
6+
---
7+
8+
# New PEP
9+
10+
<!--
11+
You can use the following checklist when double-checking your PEP,
12+
and you can help complete some of it yourself if you like
13+
by ticking any boxes you're sure about, like this: [x]
14+
If you're unsure about anything, just leave it blank and we'll take a look.
15+
16+
If your PEP is not Standards Track, remove the corresponding section.
17+
-->
18+
19+
## Basic requirements (all PEP Types)
20+
21+
* [ ] Read and followed [PEP 1](https://peps.python.org/1) & [PEP 12](https://peps.python.org/12)
22+
* [ ] File created from the [latest PEP template](https://github.com/python/peps/blob/main/pep-0012/pep-NNNN.rst?plain=1)
23+
* [ ] PEP has next available number, & set in filename (``pep-NNNN.rst``), PR title (``PEP 123: <Title of PEP>``) and ``PEP`` header
24+
* [ ] Title clearly, accurately and concisely describes the content in 79 characters or less
25+
* [ ] ``PEP``, ``Title``, ``Author``, ``Status`` (``Draft``), ``Type`` and ``Created`` headers filled out correctly
26+
* [ ] ``PEP-Delegate``, ``Topic``, ``Requires`` and ``Replaces`` headers completed if appropriate
27+
* [ ] Core dev/PEP editor listed as author or sponsor, and formally confirmed their approval
28+
* [ ] Required sections included
29+
* [ ] Abstract (first section)
30+
* [ ] Copyright (last section; exact wording from template required)
31+
* [ ] Code is well-formatted (PEP 7/PEP 8) and is in [code blocks, with the right lexer names](https://peps.python.org/pep-0012/#literal-blocks) if non-Python
32+
* [ ] PEP builds with no warnings, pre-commit checks pass and content displays as intended in the rendered HTML
33+
* [ ] Authors/sponsor added to ``.github/CODEOWNERS`` for the PEP
34+
35+
36+
## Standards Track requirements
37+
38+
* [ ] PEP topic [discussed in a suitable venue](https://peps.python.org/pep-0001/#start-with-an-idea-for-python) with general agreement that a PEP is appropriate
39+
* [ ] [Suggested sections](https://peps.python.org/pep-0012/#suggested-sections) included (unless not applicable)
40+
* [ ] Motivation
41+
* [ ] Rationale
42+
* [ ] Specification
43+
* [ ] Backwards Compatibility
44+
* [ ] Security Implications
45+
* [ ] How to Teach This
46+
* [ ] Reference Implementation
47+
* [ ] Rejected Ideas
48+
* [ ] Open Issues
49+
* [ ] ``Python-Version`` set to valid (pre-beta) future Python version
50+
* [ ] Any project stated in the PEP as supporting/endorsing/benefiting from it confirms such
51+
* [ ] Right before or after initial merging, [PEP discussion thread](https://peps.python.org/pep-0001/#discussing-a-pep) created and linked to in ``Discussions-To`` and ``Post-History``

‎.github/PULL_REQUEST_TEMPLATE/other.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
name: Other
3+
about: Infra or meta change not falling in another category
4+
---
5+
6+
<!--
7+
**Please** read our Contributing Guidelines (CONTRIBUTING.rst)
8+
to make sure this repo is the right place for your proposed change. Thanks!
9+
-->

0 commit comments

Comments
 (0)
0