Further revise PR checklists to clarity Standards Track vs other PEPs

python · hugovk · Feb 1, 2023 · Jan 9, 2023 · Jan 9, 2023 · Jan 9, 2023
commit 639af1b90e6c10c63d85de6c4944efb15eb7282c
@@ -1,6 +1,6 @@
 ---
 name: Accept/Reject PEP
-about: Mark a draft PEP as accepted or rejected
+about: Mark a draft Standards Track PEP as accepted or rejected
 ---
 
 <!--

@@ -1,6 +1,6 @@
 ---
 name: Mark PEP Final
-about: Mark an Accepted PEP as Final
+about: Mark an Accepted Standards Track PEP as Final
 ---
 
 <!--
@@ -22,7 +22,7 @@ Thanks!
 
 <!--
 
-This checklist contains the key changes needed to mark a PEP as Final.
+This checklist contains the key changes needed to mark a Standards Track PEP Final.
 
 You can help complete it yourself if you like
 by ticking any boxes you're sure about, like this: [x]
@@ -31,8 +31,8 @@ If you're unsure about something, just leave it blank and we'll take a look.
 -->
 
 
-* [ ] Final implementation has been merged (including tests and documentation)
+* [ ] Final implementation has been merged (including tests and docs)
 * [ ] PEP matches the final implementation
 * [ ] Any substantial changes since the accepted version approved by the SC/PEP delegate
-* [ ] ``Status`` changed to ``Final``
+* [ ] ``Status`` changed to ``Final`` (and ``Python-Version`` is correct)
 * [ ] Canonical docs/spec linked with a ``canonical-doc`` directive (or ``pypa-spec``, for packaging PEPs)
@@ -1,6 +1,6 @@
 ---
-name: New Standards Track PEP
-about: Submit a new draft Standards Track PEP for consideration
+name: New PEP
+about: Submit a new draft PEP
 labels: "new-pep"
 ---
 
@@ -32,15 +32,29 @@ and you can help complete some of it yourself if you like
 by ticking any boxes you're sure about, like this: [x]
 If you're unsure about anything, just leave it blank and we'll take a look.
 
+If your PEP is not Standards Track, remove the corresponding section.
+
 -->
 
+## Basic requirements (all PEP Types)
+
 * [ ] File created from the [latest PEP template](https://github.com/python/peps/blob/main/pep-0012/pep-NNNN.rst?plain=1)
+* [ ] PEP has next available number, with filename (``pep-NNNN.rst``) and ``PEP`` header set accordingly
+* [ ] Title clearly, accurately and concisely describes the content in 79 characters or less
+* [ ] ``PEP``, ``Title``, ``Author``, ``Status`` (``Draft``), ``Type`` and ``Created`` headers filled out correctly
+* [ ] ``Sponsor``, ``PEP-Delegate``, ``Topic``, ``Requires`` and ``Replaces`` headers completed if appropriate
+* [ ] Required sections included
+    * [ ] Abstract (first section)
+    * [ ] Copyright (last section; exact wording from template required)
+* [ ] 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
+* [ ] PEP builds with no warnings, pre-commit checks pass and content displays as intended in the rendered HTML
+* [ ] Authors/sponsor added to ``.github/CODEOWNERS`` for the PEP
+
 
-### Content requirements
+## Standards Track requirements
 
 * [ ] 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
-* [ ] [Required and suggested sections](https://peps.python.org/pep-0012/#suggested-sections) included (unless not applicable)
-    * [ ] Abstract (required; first section)~
+* [ ] [Suggested sections](https://peps.python.org/pep-0012/#suggested-sections) included (unless not applicable)
     * [ ] Motivation
     * [ ] Rationale
     * [ ] Specification
@@ -50,18 +64,6 @@ If you're unsure about anything, just leave it blank and we'll take a look.
     * [ ] Reference Implementation
     * [ ] Rejected Ideas
     * [ ] Open Issues
-    * [ ] Copyright (required with exact wording; last section)
-* [ ] Title clearly, accurately and concisely describes the content in 79 characters or less
-* [ ] Code is well-formatted (PEP 7/PEP 8) and is in [code blocks, with the right lexer name](https://peps.python.org/pep-0012/#literal-blocks) if non-Python
-* [ ] Any project stated in the PEP as supporting/endorsing benefiting from it confirms such
-
-
-### Technical requirements
-
-* [ ] Filename in the correct format (``pep-NNNN.rst``)
-* [ ] ``PEP``, ``Title``, ``Author``, ``Status`` (``Draft``), ``Type`` and ``Created`` headers filled out correctly
-* [ ] ``Sponsor``, ``PEP-Delegate``, ``Requires``, ``Python-Version`` and ``Replaces`` completed if appropriate
-* [ ] PEP builds with no warnings, CI checks pass and content displays as intended in the rendered preview
-* [ ] PEP number assigned by the PEP editors and filename & ``PEP`` header updated accordingly
-* [ ] Sponsor/author(s) that are core devs/PEP editors added to ``.github/CODEOWNERS`` for the PEP
+* [ ] ``Python-Version`` set to valid (pre-beta) future Python version
+* [ ] Any project stated in the PEP as supporting/endorsing/benefiting from it confirms such
 * [ ] 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 ``
38DA
Post-History``