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>
This commit is contained in:
parent
c36b348151
commit
f009036f37
|
@ -1,11 +0,0 @@
|
|||
<!--
|
||||
|
||||
*Please* read our Contributing Guidelines (CONTRIBUTING.rst)
|
||||
before submitting an issue or pull request to this repository,
|
||||
to make sure this repo is the appropriate venue for your proposed change.
|
||||
|
||||
Prefix the pull request title with the PEP number; for example:
|
||||
|
||||
PEP NNN: Summary of the changes made
|
||||
|
||||
-->
|
|
@ -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
|
||||
|
||||
<!--
|
||||
You can help complete the following checklist 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.
|
||||
-->
|
||||
|
||||
* [ ] 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
|
|
@ -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
|
||||
|
||||
<!--
|
||||
You can help complete the following checklist yourself if you like
|
||||
by ticking any boxes you're sure about, like this: [x]
|
||||
If you're unsure about something, just leave it blank and we'll take a look.
|
||||
-->
|
||||
|
||||
* [ ] 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)
|
|
@ -0,0 +1,16 @@
|
|||
---
|
||||
name: Update/modify PEP
|
||||
about: Add to or change an existing PEP
|
||||
title: "PEP NNN: Description of change"
|
||||
---
|
||||
|
||||
<!--
|
||||
**Please** read our Contributing Guidelines (CONTRIBUTING.rst)
|
||||
to make sure this repo is the right place for your proposed change. Thanks!
|
||||
-->
|
||||
|
||||
* 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``)
|
|
@ -0,0 +1,51 @@
|
|||
---
|
||||
name: New PEP
|
||||
about: Submit a new draft PEP
|
||||
title: "PEP NNN: Title of PEP"
|
||||
labels: "new-pep"
|
||||
---
|
||||
|
||||
# New PEP
|
||||
|
||||
<!--
|
||||
You can use the following checklist when double-checking your PEP,
|
||||
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)
|
||||
|
||||
* [ ] 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: <Title of PEP>``) 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``
|
|
@ -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!
|
||||
-->
|
Loading…
Reference in New Issue