From a32e59d2967d02dc334e379b4de77265b61b5b04 Mon Sep 17 00:00:00 2001 From: Barry Warsaw Date: Sat, 31 Jan 2026 15:56:50 -0800 Subject: [PATCH 01/11] Add a Change History section. --- peps/pep-0001.rst | 9 ++++++++- peps/pep-0012/pep-NNNN.rst | 7 +++++++ 2 files changed, 15 insertions(+), 1 deletion(-) diff --git a/peps/pep-0001.rst b/peps/pep-0001.rst index 739993b179a..4ea95f1d512 100644 --- a/peps/pep-0001.rst +++ b/peps/pep-0001.rst @@ -581,7 +581,14 @@ 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 `an example + `_. + +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). diff --git a/peps/pep-0012/pep-NNNN.rst b/peps/pep-0012/pep-NNNN.rst index a86f1948e62..eba800a54e4 100644 --- a/peps/pep-0012/pep-NNNN.rst +++ b/peps/pep-0012/pep-NNNN.rst @@ -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 ========= From 395cb7dd07c82e74fcc357d8b449b8da73b84046 Mon Sep 17 00:00:00 2001 From: Barry Warsaw Date: Sat, 31 Jan 2026 16:07:00 -0800 Subject: [PATCH 02/11] Linting --- peps/pep-0001.rst | 3 +-- peps/pep-0012/pep-NNNN.rst | 4 ++-- 2 files changed, 3 insertions(+), 4 deletions(-) diff --git a/peps/pep-0001.rst b/peps/pep-0001.rst index 4ea95f1d512..1a6d61a2710 100644 --- a/peps/pep-0001.rst +++ b/peps/pep-0001.rst @@ -585,8 +585,7 @@ Each PEP should have the following parts/sections: 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 `an example - `_. + 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). diff --git a/peps/pep-0012/pep-NNNN.rst b/peps/pep-0012/pep-NNNN.rst index eba800a54e4..0557f983dd0 100644 --- a/peps/pep-0012/pep-NNNN.rst +++ b/peps/pep-0012/pep-NNNN.rst @@ -91,8 +91,8 @@ Footnotes Change History ============== -A summary of major changes the PEP has undergone. Add a dated entry here whenever you update the -``Post-History`` header. +[A summary of major changes the PEP has undergone. Add a dated entry here whenever you update the +``Post-History`` header.] Copyright From a914a0d91e16243c7300ddc5b1860d01c208f215 Mon Sep 17 00:00:00 2001 From: Barry Warsaw Date: Sun, 1 Feb 2026 21:47:09 -0800 Subject: [PATCH 03/11] Add a few missing suggested section headers to the PR template --- .github/PULL_REQUEST_TEMPLATE/Add a new PEP.md | 3 +++ peps/pep-0012/pep-NNNN.rst | 4 ++-- 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE/Add a new PEP.md b/.github/PULL_REQUEST_TEMPLATE/Add a new PEP.md index 48aaa3072b7..a3cc33f0963 100644 --- a/.github/PULL_REQUEST_TEMPLATE/Add a new PEP.md +++ b/.github/PULL_REQUEST_TEMPLATE/Add a new PEP.md @@ -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`` diff --git a/peps/pep-0012/pep-NNNN.rst b/peps/pep-0012/pep-NNNN.rst index 0557f983dd0..d201f78720c 100644 --- a/peps/pep-0012/pep-NNNN.rst +++ b/peps/pep-0012/pep-NNNN.rst @@ -76,8 +76,8 @@ Open Issues [Any points that are still being decided/discussed.] -Acknowledgements -================ +Acknowledgments +=============== [Thank anyone who has helped with the PEP.] From d0201230e9da0325de90e323310d42b3ab30ef93 Mon Sep 17 00:00:00 2001 From: Barry Warsaw Date: Mon, 2 Feb 2026 09:46:53 -0800 Subject: [PATCH 04/11] /me shakes fist at Noah Webster --- .github/PULL_REQUEST_TEMPLATE/Add a new PEP.md | 2 +- peps/pep-0012/pep-NNNN.rst | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE/Add a new PEP.md b/.github/PULL_REQUEST_TEMPLATE/Add a new PEP.md index a3cc33f0963..a0fa05e9932 100644 --- a/.github/PULL_REQUEST_TEMPLATE/Add a new PEP.md +++ b/.github/PULL_REQUEST_TEMPLATE/Add a new PEP.md @@ -37,7 +37,7 @@ If your PEP is not Standards Track, remove the corresponding section. * [ ] Reference Implementation * [ ] Rejected Ideas * [ ] Open Issues - * [ ] Acknowledgments + * [ ] Acknowledgements * [ ] Footnotes * [ ] Change History * [ ] ``Python-Version`` set to valid (pre-beta) future Python version, if relevant diff --git a/peps/pep-0012/pep-NNNN.rst b/peps/pep-0012/pep-NNNN.rst index d201f78720c..0557f983dd0 100644 --- a/peps/pep-0012/pep-NNNN.rst +++ b/peps/pep-0012/pep-NNNN.rst @@ -76,8 +76,8 @@ Open Issues [Any points that are still being decided/discussed.] -Acknowledgments -=============== +Acknowledgements +================ [Thank anyone who has helped with the PEP.] From c6f8e617f783b0f8919333c6ff351182a5443e61 Mon Sep 17 00:00:00 2001 From: Barry Warsaw Date: Mon, 2 Feb 2026 11:52:31 -0800 Subject: [PATCH 05/11] Elaborate the format of the Change History section * Specify MMM-DD-YYYY bullets * Specify reverse chronological order * Fix a typo and standardize capitalization --- peps/pep-0001.rst | 8 +++++--- peps/pep-0012.rst | 6 +++--- peps/pep-0012/pep-NNNN.rst | 5 +++-- 3 files changed, 11 insertions(+), 8 deletions(-) diff --git a/peps/pep-0001.rst b/peps/pep-0001.rst index 1a6d61a2710..809b0df8c21 100644 --- a/peps/pep-0001.rst +++ b/peps/pep-0001.rst @@ -583,9 +583,11 @@ Each PEP should have the following parts/sections: 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>`. + ``Post-History`` header for major changes, add a new bullet item in newest-first (i.e. reverse + chronological) order, using the same ``MMM-DD-YYYY`` format, with sub-bullets summarizing the changes. + 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). diff --git a/peps/pep-0012.rst b/peps/pep-0012.rst index 377fc915db7..6e911194a09 100644 --- a/peps/pep-0012.rst +++ b/peps/pep-0012.rst @@ -100,8 +100,8 @@ directions below. feature is described in a Final PEP. - Change the Created header to today's date. Be sure to follow the - format carefully: it must be in ``dd-mmm-yyyy`` format, where the - ``mmm`` is the 3 English letter month abbreviation, i.e. one of Jan, + format carefully: it must be in ``DD-MMM-YYYY`` format, where the + ``MMM`` is the 3 English letter month abbreviation, i.e. one of Jan, Feb, Mar, Apr, May, Jun, Jul, Aug, Sep, Oct, Nov, Dec. - For Standards Track PEPs, after the Created header, add a @@ -122,7 +122,7 @@ directions below. - Post-History can be 'Pending' for now; you'll add dates and corresponding links to this header each time you post your PEP to the designated discussion forum (and update the Discussions-To header with said link, as above). - For each thread, use the date (in the ``dd-mmm-yyy`` format) as the + For each thread, use the date (in the ``DD-MMM-YYYY`` format) as the linked text, and insert the URLs inline as anonymous reST `hyperlinks`_, with commas in between each posting. diff --git a/peps/pep-0012/pep-NNNN.rst b/peps/pep-0012/pep-NNNN.rst index 0557f983dd0..16dfb4fb0fa 100644 --- a/peps/pep-0012/pep-NNNN.rst +++ b/peps/pep-0012/pep-NNNN.rst @@ -91,8 +91,9 @@ Footnotes Change History ============== -[A summary of major changes the PEP has undergone. Add a dated entry here whenever you update the -``Post-History`` header.] +[A summary of major changes the PEP has undergone. Whenever you update the ``Post-History``, add a new bullet +item in newest-first (i.e. reverse chronological) order, using the same ``MMM-DD-YYYY`` format, with +sub-bullets summarizing the changes.] Copyright From 5dc44cc71c861f1a85506d4c073cf63f42351211 Mon Sep 17 00:00:00 2001 From: Barry Warsaw Date: Mon, 2 Feb 2026 13:01:22 -0800 Subject: [PATCH 06/11] Add a Change History to PEP 1 --- peps/pep-0001.rst | 14 +++++++++++--- peps/pep-0012/pep-NNNN.rst | 3 ++- 2 files changed, 13 insertions(+), 4 deletions(-) diff --git a/peps/pep-0001.rst b/peps/pep-0001.rst index 809b0df8c21..81d7faac0ce 100644 --- a/peps/pep-0001.rst +++ b/peps/pep-0001.rst @@ -585,9 +585,9 @@ Each PEP should have the following parts/sections: Think of this as a "changelog" or "release notes" for the PEP. In general, whenever you update the ``Post-History`` header for major changes, add a new bullet item in newest-first (i.e. reverse chronological) order, using the same ``MMM-DD-YYYY`` format, with sub-bullets summarizing the changes. - 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>`. + You can consider linking this to the same link as the ``Post-History`` link. 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). @@ -884,6 +884,14 @@ Footnotes .. _Contributing Guide: https://github.com/python/peps/blob/main/CONTRIBUTING.rst +Change History +============== + +* 2026-02-02 + + * Added an optional ``Change History`` section for PEPs, for summarizing changes when updating the + ``Post-History`` header. + Copyright ========= diff --git a/peps/pep-0012/pep-NNNN.rst b/peps/pep-0012/pep-NNNN.rst index 16dfb4fb0fa..6c5c3286ca0 100644 --- a/peps/pep-0012/pep-NNNN.rst +++ b/peps/pep-0012/pep-NNNN.rst @@ -93,7 +93,8 @@ Change History [A summary of major changes the PEP has undergone. Whenever you update the ``Post-History``, add a new bullet item in newest-first (i.e. reverse chronological) order, using the same ``MMM-DD-YYYY`` format, with -sub-bullets summarizing the changes.] +sub-bullets summarizing the changes. You can use the same link for the date bullet as you do in the +``Post-History`` addition.] Copyright From 556f6add47505282c3671c6220ca86c785433a47 Mon Sep 17 00:00:00 2001 From: Barry Warsaw Date: Mon, 2 Feb 2026 13:29:54 -0800 Subject: [PATCH 07/11] Update peps/pep-0012/pep-NNNN.rst Co-authored-by: Marc Mueller <30130371+cdce8p@users.noreply.github.com> --- peps/pep-0012/pep-NNNN.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/peps/pep-0012/pep-NNNN.rst b/peps/pep-0012/pep-NNNN.rst index 6c5c3286ca0..e1bbe5a75d3 100644 --- a/peps/pep-0012/pep-NNNN.rst +++ b/peps/pep-0012/pep-NNNN.rst @@ -92,7 +92,7 @@ Change History ============== [A summary of major changes the PEP has undergone. Whenever you update the ``Post-History``, add a new bullet -item in newest-first (i.e. reverse chronological) order, using the same ``MMM-DD-YYYY`` format, with +item in newest-first (i.e. reverse chronological) order, using the same ``DD-MMM-YYYY`` format, with sub-bullets summarizing the changes. You can use the same link for the date bullet as you do in the ``Post-History`` addition.] From 2b0407a98967f3130e7864cb1578f36b56139f68 Mon Sep 17 00:00:00 2001 From: Barry Warsaw Date: Mon, 2 Feb 2026 13:30:07 -0800 Subject: [PATCH 08/11] Update peps/pep-0001.rst Co-authored-by: Marc Mueller <30130371+cdce8p@users.noreply.github.com> --- peps/pep-0001.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/peps/pep-0001.rst b/peps/pep-0001.rst index 81d7faac0ce..b3c7950009b 100644 --- a/peps/pep-0001.rst +++ b/peps/pep-0001.rst @@ -584,7 +584,7 @@ Each PEP should have the following parts/sections: 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, add a new bullet item in newest-first (i.e. reverse - chronological) order, using the same ``MMM-DD-YYYY`` format, with sub-bullets summarizing the changes. + chronological) order, using the same ``DD-MMM-YYYY`` format, with sub-bullets summarizing the changes. You can consider linking this to the same link as the ``Post-History`` link. 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>`. From 44ae712570b85f7aa6c813eff128d069750139f6 Mon Sep 17 00:00:00 2001 From: Barry Warsaw Date: Tue, 3 Feb 2026 09:31:57 -0800 Subject: [PATCH 09/11] Update peps/pep-0012/pep-NNNN.rst Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com> --- peps/pep-0012/pep-NNNN.rst | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/peps/pep-0012/pep-NNNN.rst b/peps/pep-0012/pep-NNNN.rst index e1bbe5a75d3..b5e16a866ce 100644 --- a/peps/pep-0012/pep-NNNN.rst +++ b/peps/pep-0012/pep-NNNN.rst @@ -91,10 +91,11 @@ Footnotes Change History ============== -[A summary of major changes the PEP has undergone. Whenever you update the ``Post-History``, add a new bullet -item in newest-first (i.e. reverse chronological) order, using the same ``DD-MMM-YYYY`` format, with -sub-bullets summarizing the changes. You can use the same link for the date bullet as you do in the -``Post-History`` addition.] +[A summary of major changes the PEP has undergone. Whenever you update the +``Post-History``, add a new bullet item in newest-first (i.e. reverse +chronological) order, using the same ``DD-MMM-YYYY`` format, with sub-bullets +summarizing the changes. You can use the same link for the date bullet as you +do in the ``Post-History`` addition.] Copyright From cbbcfbe9e7784fd4f35f3e47516869e770aec0bc Mon Sep 17 00:00:00 2001 From: Barry Warsaw Date: Tue, 3 Feb 2026 09:32:18 -0800 Subject: [PATCH 10/11] Update peps/pep-0012.rst Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com> --- peps/pep-0012.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/peps/pep-0012.rst b/peps/pep-0012.rst index 6e911194a09..dc21a20dcc0 100644 --- a/peps/pep-0012.rst +++ b/peps/pep-0012.rst @@ -101,7 +101,7 @@ directions below. - Change the Created header to today's date. Be sure to follow the format carefully: it must be in ``DD-MMM-YYYY`` format, where the - ``MMM`` is the 3 English letter month abbreviation, i.e. one of Jan, + ``MMM`` is the three-letter English month abbreviation, i.e. one of Jan, Feb, Mar, Apr, May, Jun, Jul, Aug, Sep, Oct, Nov, Dec. - For Standards Track PEPs, after the Created header, add a From 9c6cde998211b90aabff9f72eedff300f44e42f8 Mon Sep 17 00:00:00 2001 From: Barry Warsaw Date: Tue, 3 Feb 2026 09:37:08 -0800 Subject: [PATCH 11/11] Update peps/pep-0001.rst Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com> --- peps/pep-0001.rst | 17 ++++++++++------- 1 file changed, 10 insertions(+), 7 deletions(-) diff --git a/peps/pep-0001.rst b/peps/pep-0001.rst index b3c7950009b..e8fbdceca8a 100644 --- a/peps/pep-0001.rst +++ b/peps/pep-0001.rst @@ -581,13 +581,16 @@ 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. 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, add a new bullet item in newest-first (i.e. reverse - chronological) order, using the same ``DD-MMM-YYYY`` format, with sub-bullets summarizing the changes. - You can consider linking this to the same link as the ``Post-History`` link. 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>`. +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, add a new bullet item in newest-first (i.e. reverse + chronological) order, using the same ``DD-MMM-YYYY`` format, with + sub-bullets summarizing the changes. You can consider linking this to the + same link as the ``Post-History`` link. 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).