Skip to content

Meta: Add templates/checklists for new, Accepted/Rejected & Final PEPs #2956

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 13 commits into from
Feb 1, 2023
Merged
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
50 changes: 50 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/accept-reject-pep.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
---
name: Accept/Reject PEP
about: Mark a draft PEP as accepted or rejected
---

<!--

See PEP 1 for more details about the PEP review and resolution process:

https://peps.python.org/pep-0001/#pep-review-resolution

Make sure to include the PEP number in the pull request title; for example:

PEP NNN: Mark as Accepted/Rejected

Thanks!

-->


# Accept/Reject PEP

<!--

Link to the official acceptance/rejection message
by the Steering Council/PEP Delegate on the PEP's discussion thread.

-->



## Checklist

<!--

This lists the key steps needed to mark a PEP as Accepted/Rejected.

You can help complete 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.

-->


* [ ] SC/PEP Delegate has formally accepted/rejected the PEP and posted to the ``Discussions-To`` thread
* [ ] ``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 any major conditions or critical commentary (and any changes made accordingly)
* [ ] ``Discussions-To``, ``Post-History` and ``Python-Version`` complete and up to date
48 changes: 48 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/mark-pep-final.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
---
name: Mark PEP Final
about: Mark an Accepted PEP as Final
---

<!--

See PEP 1 for more about the PEP lifecycle and when one is considered Final:

https://peps.python.org/pep-0001/#pep-review-resolution

Make sure to include the PEP number in the pull request title; for example:

PEP NNN: Mark Final

Thanks!

-->


# Mark PEP Final

<!--

State why the PEP should be marked Final,
linking any relevant discussions, issues or PRs.

-->



## Checklist

<!--

This lists the key steps needed to mark a PEP as Final.

You can help complete it 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.

-->


* [ ] Specification has been implemented in a released stable CPython version (or third-party tools, for packaging/typing topic PEPs)
* [ ] ``Status`` changed to ``Final``
* [ ] Canonical docs/spec moved to an appropriate place, and linked with a ``canonical-doc`` directive (or ``pypa-spec``, for packaging PEPs)
* [ ] PEP headers and content updated with any substantial changes during the implementation phase
72 changes: 72 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/new-pep.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
---
name: New PEP
about: Submit a new draft PEP for consideration
labels: "new-pep"
---

<!--

Please read and follow PEP 1 and PEP 12 before submitting a new PEP:

https://peps.python.org/pep-0001/#submitting-a-pep

https://peps.python.org/pep-0012/#how-to-use-this-template

Make sure to include the PEP number in the pull request title; for example:

PEP 9999: <Title of PEP>

See our Contributing Guidelines (CONTRIBUTING.rst) for more information.

Thanks!

-->


# New PEP

<!--

Briefly describe your new PEP here, and anything else we should know.
Be sure to link to any previous discussions or issues motivating/drafting it.

-->



## Checklist

<!--

You should use the following as a guide 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.

-->

* [ ] File created from the [latest PEP template](https://github.com/python/peps/blob/main/pep-0012/pep-NNNN.rst?plain=1)

### Content requirements

* [ ] PEP topic [discussed in a suitable venue](https://peps.python.org/pep-0001/#start-with-an-idea-for-python) and general agreement that a PEP is appropriate
* [ ] Content is reasonably sound, complete and makes at least basic technical sense
* [ ] Abstract and Copyright sections completed, with the required wording in the latter
* [ ] [Suggested sections](https://peps.python.org/pep-0012/#suggested-sections) included (unless not applicable)
* [ ] Title clearly, accurately and concisely describes the content
* [ ] Prose is intelligible and generally free of basic grammar and syntax errors, at least to the degree they significantly detract from understanding
* [ ] Code is in code blocks, well-formatted (PEP 7/PEP 8) and has the right [lexer name](https://pygments.org/docs/lexers/) if non-Python (or ``text``)
* [ ] 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
* [ ] ``PEP-Delegate``, ``Requires``, ``Python-Version`` and ``Replaces`` filled out if appropriate
* [ ] ``Sponsor`` listed and approves if not authored by a core dev or PEP editor
* [ ] 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
* [ ] 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``
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
---
name: Other
about: Any PR that doesn't fall in the other categories
---

<!--

*Please* read our Contributing Guidelines (CONTRIBUTING.rst)
Expand All @@ -8,4 +13,6 @@ Prefix the pull request title with the PEP number; for example:

PEP NNN: Summary of the changes made

Thanks!

-->