Confirmed users
2,816
edits
Release Management/Relnotes rules: Difference between revisions
Jump to navigation
Jump to search
m
→Best practices for writing release notes: Added details about sec advisories and MDN notes
m (→Release note writing process: added link to folder of previous relnote drafts) |
m (→Best practices for writing release notes: Added details about sec advisories and MDN notes) |
||
| Line 69: | Line 69: | ||
* A relnote that applies to both desktop and android should be written once and associated with both releases. | * A relnote that applies to both desktop and android should be written once and associated with both releases. | ||
* Don't link to bugs. | * Don't link to bugs. (We do link to bugs in dot releases, though) | ||
* Relnotes are sentence fragments. Don't start them with 'The', 'A', etc. Don't use periods. | * Be sure to include a link to | ||
** Developer notes on MDN; example: https://developer.mozilla.org/Firefox/Releases/60 | |||
** Security advisories; example: https://www.mozilla.org/security/advisories/mfsa2018-06/ | |||
* Relnotes are sentence fragments. Don't start them with 'The', 'A', etc. Don't use periods, in general, unless there is a good reason the note has more than one sentence. | |||
* Keep relnotes as short as possible. If you find yourself wanting to start a new sentence, figure out a way to rephrase the note. | * Keep relnotes as short as possible. If you find yourself wanting to start a new sentence, figure out a way to rephrase the note. | ||