Skip to content

Commit b6a4d2d

Browse files
authored
Update style guide with info on removing a release note (#51004)
1 parent 528e236 commit b6a4d2d

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

content/contributing/style-guide-and-content-model/style-guide.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -911,7 +911,7 @@ Each release note in a set describes one of the following changes.
911911
- [Deprecations](#deprecations): removal of a feature or behavior
912912
- [Errata](#errata): correction to inaccurate release note or documentation
913913
914-
You can also review guidelines for updating release notes in [Adding or updating a release note](#adding-or-updating-a-release-note).
914+
You can also review guidelines for updating release notes in "[Adding or updating a release note](#adding-or-updating-a-release-note)" and "[Removing a release note](#removing-a-release-note)."
915915
916916
### Features
917917
@@ -1102,6 +1102,10 @@ Errata answers the following questions.
11021102
11031103
To signal to readers that you've added or changed a note, or to indicate the publication date of errata, append a datestamp in the format "[Updated: YYYY-MM-DD]".
11041104
1105+
### Removing a release note
1106+
1107+
To signal that we have removed a release note, add an "Errata" section detailing which note you removed and (if relevant) which version the removed note actually pertains to. See "[Writing errata](#writing-errata)."
1108+
11051109
## Reusables and variables
11061110
11071111
Use reusable strings for individual nouns (e.g. product names) or for complete sentences or paragraphs. Sentence fragments and phrases should not be contained in reusable strings as they can cause problems when content is localized. For more information, see the [data directory](https://github.com/github/docs/tree/main/data) in the [`github/docs`](https://github.com/github/docs) repository, "[Creating reusable content](/contributing/writing-for-github-docs/creating-reusable-content)", and the “[Product names](#product-names)” section of this document.

0 commit comments

Comments
 (0)