openstack/deb-python-reno
Code Issues Proposed changes

update template for new notes

Browse Source 
Add some details to the template for creating new notes to better
explain how the sections work.

Change-Id: If03c7deb38e3f494ade8efddc44bf107806b2df1
This commit is contained in:
Doug Hellmann
2015-11-25 18:27:45 +00:00
parent d3efb6cfc8
commit b243431998
1 changed files with 45 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

46
reno/create.py
View File

@@ -21,21 +21,65 @@ _TEMPLATE = """\
---
prelude: >
Replace this text with content to appear at the
top of the section for this release.
top of the section for this release. All of the
prelude content is merged together and then rendered
separately from the items listed in other parts of
the file, so the text needs to be worded so that
both the prelude and the other items make sense
when read independently. This may mean repeating
some details. Not every release note
requires a prelude. Usually only notes describing
major features or adding release theme details should
have a prelude.
features:
- List new features here, or remove this section.
All of the list items in this section are combined
when the release notes are rendered, so the text
needs to be worded so that it does not depend on any
information only available in another section, such
as the prelude. This may mean repeating some details.
issues:
- List known issues here, or remove this section.
All of the list items in this section are combined
when the release notes are rendered, so the text
needs to be worded so that it does not depend on any
information only available in another section, such
as the prelude. This may mean repeating some details.
upgrade:
- List upgrade notes here, or remove this section.
All of the list items in this section are combined
when the release notes are rendered, so the text
needs to be worded so that it does not depend on any
information only available in another section, such
as the prelude. This may mean repeating some details.
critical:
- Add critical notes here, or remove this section.
All of the list items in this section are combined
when the release notes are rendered, so the text
needs to be worded so that it does not depend on any
information only available in another section, such
as the prelude. This may mean repeating some details.
security:
- Add security notes here, or remove this section.
All of the list items in this section are combined
when the release notes are rendered, so the text
needs to be worded so that it does not depend on any
information only available in another section, such
as the prelude. This may mean repeating some details.
fixes:
- Add normal bug fixes here, or remove this section.
All of the list items in this section are combined
when the release notes are rendered, so the text
needs to be worded so that it does not depend on any
information only available in another section, such
as the prelude. This may mean repeating some details.
other:
- Add other notes here, or remove this section.
All of the list items in this section are combined
when the release notes are rendered, so the text
needs to be worded so that it does not depend on any
information only available in another section, such
as the prelude. This may mean repeating some details.
"""