Skip to content

Move NEWS entries to pull-request-lifecycle #1506

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

Open
wants to merge 9 commits into
base: main
Choose a base branch
from
Open
Changes from 1 commit
Commits
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
Prev Previous commit
Next Next commit
Change title levels
  • Loading branch information
StanFromIreland committed Feb 3, 2025
commit 6f6fbaeb6df2bd439242b59b9536ed611644cde7
10 changes: 5 additions & 5 deletions getting-started/pull-request-lifecycle.rst
Original file line number Diff line number Diff line change
Expand Up @@ -241,10 +241,10 @@ should do to help ensure that your pull request is accepted.
.. _what-s-new-and-news-entries:

Updating NEWS and What's New in Python
--------------------------------------
======================================

Changes that require NEWS entries
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
---------------------------------

Most changes made to the codebase deserve an entry in :cpy-file:`Misc/NEWS.d`,
except for the following:
Expand All @@ -268,7 +268,7 @@ For the last two, note the following:
entry is needed.

Changes that require "What's New in Python" entries
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
---------------------------------------------------

If a change is particularly interesting for end users (for example, new features,
significant improvements, or backwards-incompatible changes), add an entry in
Expand All @@ -284,7 +284,7 @@ in the "What's New in Python" entry.
is very likely not suitable for inclusion in a maintenance release.

How to add a NEWS entry
^^^^^^^^^^^^^^^^^^^^^^^
-----------------------

``NEWS`` entries go into the ``Misc/NEWS.d`` directory as individual files. The
``NEWS`` entry can be created by using `blurb-it <https://blurb-it.herokuapp.com/>`_,
Expand All @@ -310,7 +310,7 @@ As a result, a file name can look something like
``Misc/NEWS.d/next/Library/2017-05-27-16-46-23.gh-issue-12345.Yl4gI2.rst``.

How to write a NEWS entry
^^^^^^^^^^^^^^^^^^^^^^^^^
-------------------------

All ``NEWS`` entries end up being part of the changelog.
The changelog contains *a lot* of entries,
Expand Down
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy