Repository navigation
Explain how to write a NEWS entry on the add_blurb form - #475
Merged
Merged
Conversation
Mariatta
force-pushed
the
news-entry-tips
branch
5 times, most recently
from
October 22, 2026 00:37
99defcf to
5defe26
Compare
Replace the three-line textarea placeholder with a guide above the field that follows the devguide's current advice: one or two sentences, start with an imperative verb, name what changed with inline markup, say what users will notice, and leave out implementation details and references to the pull request. The guide is an accordion in the theme's info colours so it stands out. It opens for first-time visitors; once collapsed, the browser remembers the choice. Link to the devguide's "How to write a NEWS entry" section, and point the command line link at the section that covers blurb add.
Mariatta
force-pushed
the
news-entry-tips
branch
from
October 22, 2026 00:54
5defe26 to
3348b8f
Compare
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
The NEWS entry textarea only carried a three-line placeholder that disappears as soon as you start typing, and it said little about what makes a good entry.
This adds a guide above the field that follows the devguide's How to write a NEWS entry section: one or two sentences, start with an imperative verb, name what changed with inline markup such as
:func:, say what users will notice, and leave out implementation details and phrases like "this PR". It uses the devguide's own preferred example and links to the section for the full guidance.The guide is a Bootstrap accordion in the theme's info colours so it stands out from the form. It opens for first-time visitors; once collapsed, the browser remembers the choice in local storage and keeps it collapsed on later visits. Without JavaScript it is simply open.
The textarea gets a short help line, and the "blurb on the command line" link now points at the devguide section that covers
blurb addand opens in a new tab so a half-written entry is not lost.Screenshot
Demo