diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 8db9fc296e6..00000000000 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,11 +0,0 @@ - diff --git a/.github/PULL_REQUEST_TEMPLATE/accept-reject-pep.md b/.github/PULL_REQUEST_TEMPLATE/accept-reject-pep.md new file mode 100644 index 00000000000..4bdbb0a6d21 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/accept-reject-pep.md @@ -0,0 +1,21 @@ +--- +name: Accept/Reject PEP +about: Mark a draft Standards Track PEP as accepted or rejected +title: "PEP NNN: Mark as Accepted" +--- + +# Accept/Reject PEP + + + +* [ ] SC/PEP Delegate has formally accepted/rejected the PEP and posted to the ``Discussions-To`` thread +* [ ] Pull request title in appropriate format (``PEP 123: Mark as Accepted``) +* [ ] ``Status`` changed to ``Accepted``/``Rejected`` +* [ ] ``Resolution`` link points directly to SC/PEP Delegate official acceptance/rejected post +* [ ] Acceptance/rejection notice added, if the SC/PEP delegate had major conditions or comments +* [ ] ``Discussions-To``, ``Post-History`` and ``Python-Version`` up to date diff --git a/.github/PULL_REQUEST_TEMPLATE/mark-pep-final.md b/.github/PULL_REQUEST_TEMPLATE/mark-pep-final.md new file mode 100644 index 00000000000..41f0a57ec44 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/mark-pep-final.md @@ -0,0 +1,20 @@ +--- +name: Mark PEP Final +about: Mark an Accepted Standards Track PEP as Final +title: "PEP NNN: Mark Final" +--- + +# Mark PEP Final + + + +* [ ] 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 +* [ ] Pull request title in appropriate format (``PEP 123: Mark 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) diff --git a/.github/PULL_REQUEST_TEMPLATE/modify-pep.md b/.github/PULL_REQUEST_TEMPLATE/modify-pep.md new file mode 100644 index 00000000000..c04c4e78b54 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/modify-pep.md @@ -0,0 +1,16 @@ +--- +name: Update/modify PEP +about: Add to or change an existing PEP +title: "PEP NNN: Description of change" +--- + + + +* Change is either: + * [ ] To a Draft PEP + * [ ] To an Accepted or Final PEP, with Steering Council approval + * [ ] To fix an editorial issue (markup, typo, link, header, etc) +* [ ] PR title prefixed with PEP number (e.g. ``PEP 123: Summary of changes``) diff --git a/.github/PULL_REQUEST_TEMPLATE/new-pep.md b/.github/PULL_REQUEST_TEMPLATE/new-pep.md new file mode 100644 index 00000000000..19f230e3410 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/new-pep.md @@ -0,0 +1,51 @@ +--- +name: New PEP +about: Submit a new draft PEP +title: "PEP NNN: Title of PEP" +labels: "new-pep" +--- + +# New PEP + + + +## Basic requirements (all PEP Types) + +* [ ] Read and followed [PEP 1](https://peps.python.org/1) & [PEP 12](https://peps.python.org/12) +* [ ] 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, & set in filename (``pep-NNNN.rst``), PR title (``PEP 123: ``) and ``PEP`` header +* [ ] 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 +* [ ] ``PEP-Delegate``, ``Topic``, ``Requires`` and ``Replaces`` headers completed if appropriate +* [ ] Core dev/PEP editor listed as author or sponsor, and formally confirmed their approval +* [ ] 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 + + +## 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 +* [ ] [Suggested sections](https://peps.python.org/pep-0012/#suggested-sections) included (unless not applicable) + * [ ] Motivation + * [ ] Rationale + * [ ] Specification + * [ ] Backwards Compatibility + * [ ] Security Implications + * [ ] How to Teach This + * [ ] Reference Implementation + * [ ] Rejected Ideas + * [ ] Open Issues +* [ ] ``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 ``Post-History`` diff --git a/.github/PULL_REQUEST_TEMPLATE/other.md b/.github/PULL_REQUEST_TEMPLATE/other.md new file mode 100644 index 00000000000..cfc11d00882 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE/other.md @@ -0,0 +1,9 @@ +--- +name: Other +about: Infra or meta change not falling in another category +--- + +<!-- +**Please** read our Contributing Guidelines (CONTRIBUTING.rst) +to make sure this repo is the right place for your proposed change. Thanks! +-->