Skip to content

Commit 5dc44cc

Browse files
committed
Add a Change History to PEP 1
1 parent c6f8e61 commit 5dc44cc

2 files changed

Lines changed: 13 additions & 4 deletions

File tree

peps/pep-0001.rst

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -585,9 +585,9 @@ Each PEP should have the following parts/sections:
585585
Think of this as a "changelog" or "release notes" for the PEP. In general, whenever you update the
586586
``Post-History`` header for major changes, add a new bullet item in newest-first (i.e. reverse
587587
chronological) order, using the same ``MMM-DD-YYYY`` format, with sub-bullets summarizing the changes.
588-
This isn't mandatory, so it's left to the PEP author's discretion, but such a section can be helpful for
589-
those following along to understand the evolution of your PEP. Here is :pep:`an example
590-
<694#change-history>`.
588+
You can consider linking this to the same link as the ``Post-History`` link. This isn't mandatory, so
589+
it's left to the PEP author's discretion, but such a section can be helpful for those following along to
590+
understand the evolution of your PEP. Here is :pep:`an example <694#change-history>`.
591591

592592
15. Copyright/license -- Each new PEP must be placed under a dual license of
593593
public domain and CC0-1.0-Universal_ (see this PEP for an example).
@@ -884,6 +884,14 @@ Footnotes
884884
.. _Contributing Guide: https://github.com/python/peps/blob/main/CONTRIBUTING.rst
885885

886886

887+
Change History
888+
==============
889+
890+
* 2026-02-02
891+
892+
* Added an optional ``Change History`` section for PEPs, for summarizing changes when updating the
893+
``Post-History`` header.
894+
887895
Copyright
888896
=========
889897

peps/pep-0012/pep-NNNN.rst

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,8 @@ Change History
9393

9494
[A summary of major changes the PEP has undergone. Whenever you update the ``Post-History``, add a new bullet
9595
item in newest-first (i.e. reverse chronological) order, using the same ``MMM-DD-YYYY`` format, with
96-
sub-bullets summarizing the changes.]
96+
sub-bullets summarizing the changes. You can use the same link for the date bullet as you do in the
97+
``Post-History`` addition.]
9798

9899

99100
Copyright

0 commit comments

Comments
 (0)