|
| 1 | +--- |
| 2 | +prelude: > |
| 3 | + Replace this text with content to appear at the top of the section for this |
| 4 | + release. All of the prelude content is merged together and then rendered |
| 5 | + separately from the items listed in other parts of the file, so the text |
| 6 | + needs to be worded so that both the prelude and the other items make sense |
| 7 | + when read independently. This may mean repeating some details. Not every |
| 8 | + release note requires a prelude. Usually only notes describing major |
| 9 | + features or adding release theme details should have a prelude. |
| 10 | +features: |
| 11 | + - | |
| 12 | + List new features here, or remove this section. All of the list items in |
| 13 | + this section are combined when the release notes are rendered, so the text |
| 14 | + needs to be worded so that it does not depend on any information only |
| 15 | + available in another section, such as the prelude. This may mean repeating |
| 16 | + some details. |
| 17 | +issues: |
| 18 | + - | |
| 19 | + List known issues here, or remove this section. All of the list items in |
| 20 | + this section are combined when the release notes are rendered, so the text |
| 21 | + needs to be worded so that it does not depend on any information only |
| 22 | + available in another section, such as the prelude. This may mean repeating |
| 23 | + some details. |
| 24 | +upgrade: |
| 25 | + - | |
| 26 | + List upgrade notes here, or remove this section. All of the list items in |
| 27 | + this section are combined when the release notes are rendered, so the text |
| 28 | + needs to be worded so that it does not depend on any information only |
| 29 | + available in another section, such as the prelude. This may mean repeating |
| 30 | + some details. |
| 31 | +deprecations: |
| 32 | + - | |
| 33 | + List deprecations notes here, or remove this section. All of the list |
| 34 | + items in this section are combined when the release notes are rendered, so |
| 35 | + the text needs to be worded so that it does not depend on any information |
| 36 | + only available in another section, such as the prelude. This may mean |
| 37 | + repeating some details. |
| 38 | +critical: |
| 39 | + - | |
| 40 | + Add critical notes here, or remove this section. All of the list items in |
| 41 | + this section are combined when the release notes are rendered, so the text |
| 42 | + needs to be worded so that it does not depend on any information only |
| 43 | + available in another section, such as the prelude. This may mean repeating |
| 44 | + some details. |
| 45 | +security: |
| 46 | + - | |
| 47 | + Add security notes here, or remove this section. All of the list items in |
| 48 | + this section are combined when the release notes are rendered, so the text |
| 49 | + needs to be worded so that it does not depend on any information only |
| 50 | + available in another section, such as the prelude. This may mean repeating |
| 51 | + some details. |
| 52 | +fixes: |
| 53 | + - | |
| 54 | + Add normal bug fixes here, or remove this section. All of the list items |
| 55 | + in this section are combined when the release notes are rendered, so the |
| 56 | + text needs to be worded so that it does not depend on any information only |
| 57 | + available in another section, such as the prelude. This may mean repeating |
| 58 | + some details. |
| 59 | +other: |
| 60 | + - | |
| 61 | + Add other notes here, or remove this section. All of the list items in |
| 62 | + this section are combined when the release notes are rendered, so the text |
| 63 | + needs to be worded so that it does not depend on any information only |
| 64 | + available in another section, such as the prelude. This may mean repeating |
| 65 | + some details. |
0 commit comments