-
-
Notifications
You must be signed in to change notification settings - Fork 880
Closed
Labels
enhancementguide-new contentAdditions; New content or section neededAdditions; New content or section needed
Description
The devguide describes in great detail how and when to write NEWS entries (reST syntax, line length, using blurb, etc.), but it barely touches on the subject of what the NEWS entry should contain. IMO we should prioritise telling what a NEWS entry is, rather than how to write it.
- Audience: Who are we writing for? This affects the detail level, and the tone of the text. This varies depending on NEWS category.
- Don't be verbose: NEWS entries are a part of a very long changelog. IMO, we should promote brevity.
- NEWS entries should communicate the actual change accurately in a way readers of the changelog will understand.
- NEWS entries should be stand-alone; they should not be dependent on the actual diff when it comes to describing the change.
ezio-melotti, JelleZijlstra and hugovk
Metadata
Metadata
Assignees
Labels
enhancementguide-new contentAdditions; New content or section neededAdditions; New content or section needed