-
-
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 5 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 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,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 | ||
CAM-Gerlach marked this conversation as resolved.
Show resolved
Hide resolved
CAM-Gerlach marked this conversation as resolved.
Show resolved
Hide resolved
|
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,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. | ||
CAM-Gerlach marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
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 | ||
CAM-Gerlach marked this conversation as resolved.
Show resolved
Hide resolved
|
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,72 @@ | ||
--- | ||
name: New PEP | ||
about: Submit a new draft PEP for consideration | ||
CAM-Gerlach marked this conversation as resolved.
Show resolved
Hide resolved
CAM-Gerlach marked this conversation as resolved.
Show resolved
Hide resolved
|
||
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. | ||
|
||
--> | ||
|
||
CAM-Gerlach marked this conversation as resolved.
Show resolved
Hide resolved
|
||
* [ ] 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 | ||
CAM-Gerlach marked this conversation as resolved.
Show resolved
Hide resolved
|
||
* [ ] Content is reasonably sound, complete and makes at least basic technical sense | ||
CAM-Gerlach marked this conversation as resolved.
Show resolved
Hide resolved
|
||
* [ ] 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) | ||
CAM-Gerlach marked this conversation as resolved.
Show resolved
Hide resolved
CAM-Gerlach marked this conversation as resolved.
Show resolved
Hide resolved
|
||
* [ ] 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 | ||
CAM-Gerlach marked this conversation as resolved.
Show resolved
Hide resolved
|
||
* [ ] 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``) | ||
CAM-Gerlach marked this conversation as resolved.
Show resolved
Hide resolved
|
||
* [ ] 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 | ||
CAM-Gerlach marked this conversation as resolved.
Show resolved
Hide resolved
|
||
* [ ] PEP builds with no warnings, CI checks pass and content displays as intended in the rendered preview | ||
CAM-Gerlach marked this conversation as resolved.
Show resolved
Hide resolved
|
||
* [ ] PEP number assigned by the PEP editors and filename & ``PEP`` header updated accordingly | ||
CAM-Gerlach marked this conversation as resolved.
Show resolved
Hide resolved
|
||
* [ ] 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`` |
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
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.