Skip to content

PEP 12 & 1: Add a Change History section #4801

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.

Sign up for GitHub

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

Open
warsaw wants to merge 3 commits into
base: main
Choose a base branch
from
Open

PEP 12 & 1: Add a Change History section #4801

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a32e59d
Add a Change History section.
warsaw Jan 31, 2026
395cb7d
Linting
warsaw Feb 1, 2026
a914a0d
Add a few missing suggested section headers to the PR template
warsaw Feb 2, 2026
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
3 changes: 3 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/Add a new PEP.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,9 @@ If your PEP is not Standards Track, remove the corresponding section.
* [ ] Reference Implementation
* [ ] Rejected Ideas
* [ ] Open Issues
* [ ] Acknowledgments
* [ ] Footnotes
* [ ] Change History
* [ ] ``Python-Version`` set to valid (pre-beta) future Python version, if relevant
* [ ] Any project stated in the PEP as supporting/endorsing/benefiting from the PEP formally confirmed 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``
8 changes: 7 additions & 1 deletion peps/pep-0001.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -581,7 +581,13 @@ Each PEP should have the following parts/sections:
13. Footnotes -- A collection of footnotes cited in the PEP, and
a place to list non-inline hyperlink targets.

14. Copyright/license -- Each new PEP must be placed under a dual license of
14. Change History -- A summary of major changes the PEP has undergone, based on discussions and feedback.
Think of this as a "changelog" or "release notes" for the PEP. In general, whenever you update the
``Post-History`` header for major changes, consider adding a dated entry in this section. This isn't
mandatory, so it's left to the PEP author's discretion, but such a section can be helpful for those
following along to understand the evolution of your PEP. Here is :pep:`an example <694#change-history>`.

15. Copyright/license -- Each new PEP must be placed under a dual license of
public domain and CC0-1.0-Universal_ (see this PEP for an example).


Expand Down
11 changes: 9 additions & 2 deletions peps/pep-0012/pep-NNNN.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,8 +76,8 @@ Open Issues
[Any points that are still being decided/discussed.]


Acknowledgements
================
Acknowledgments
===============
Comment on lines -79 to +80
Copy link
Contributor

@cdce8p cdce8p Feb 2, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

AFAICT this is just a difference in British vs American spelling. Not sure what the guidelines on that are for the repo. https://quillbot.com/blog/uk-vs-us/acknowledgement-vs-acknowledgment/

A quick search does suggest that Acknowledgements (with the additional 'e') is more popular though (111 results) vs 36 (without).


[Thank anyone who has helped with the PEP.]

Expand All @@ -88,6 +88,13 @@ Footnotes
[A collection of footnotes cited in the PEP, and a place to list non-inline hyperlink targets.]


Change History
==============

[A summary of major changes the PEP has undergone. Add a dated entry here whenever you update the
``Post-History`` header.]


Copyright
=========

Expand Down
Loading