-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
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
Changes from all commits
Commits
Show all changes
13 commits
Select commit
Hold shift + click to select a range
b0e7439
Add baseline Other template following existing
CAM-Gerlach 1c2a44a
Add New PEP template and checklist
CAM-Gerlach 1a1cee7
Add Accept/Reject PEP template and checklist
CAM-Gerlach 499a9fa
Add Mark PEP Final template and checklist
CAM-Gerlach b34f956
Remove existing single PR template so new templates work
CAM-Gerlach 83c7fbc
Apply suggestions from code review by Petr
CAM-Gerlach 639af1b
Further revise PR checklists to clarity Standards Track vs other PEPs
CAM-Gerlach ecc73f2
Further trim down template comments & move to checklist items
CAM-Gerlach a8aebdb
Add new Modify PEP template and simplify existing further
CAM-Gerlach 1a9c8de
Further refine PEP change ording per review feedback
CAM-Gerlach 84b7ac5
Add title placeholders to PR templates
CAM-Gerlach a8538d9
Quote YAML title fields in PR templates
CAM-Gerlach a0b77a2
Add back dedicated Author/Sponsor item to new PEP checklist
CAM-Gerlach File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
--- | ||
name: Update/modify PEP | ||
about: Add to or change an existing PEP | ||
title: "PEP NNN: Description of change" | ||
10000 | --- | |
|
||
<!-- | ||
**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``) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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`` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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! | ||
--> |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.