Develop a Release Notes Template #1343
Labels
A-Release-Notes
C-Feature
A new feature, making something new possible
E-Good-First-Issue
Good for newcomers
X-Uncontroversial
This work is generally agreed upon
Proposal
When stubbing out new release notes, an approachable template should be provided instead of a simple
TODO
. This will help set the tone for these individual pieces for new authors, and provide a skeleton to help overcome writers block.As an example of such a template:
I imagine the simplest way to do this automatically would be to amend the
generate_release_notes
function to inject whatever starting template is appropriate. Most of the work of this issue would likely be on the creation of the template itself.An example of previous instructions given during the creation of release notes can be found in the 0.12 announcement.
Alternatives
Perhaps including a single
Example.md
, or amending the contributors guide could also serve this purpose?This was originally discussed in the 0.14 release crew working group
The text was updated successfully, but these errors were encountered: