Release Management/Release Notes: Difference between revisions

no edit summary
(Added a Style Guide)
No edit summary
Line 42: Line 42:


For questions on the process please reach out on [https://mozilla.slack.com/archives/C9L102H6X #release-notes] internal Slack channel.
For questions on the process please reach out on [https://mozilla.slack.com/archives/C9L102H6X #release-notes] internal Slack channel.
== How to decide whether a change should be included in release notes? ==
If you think your feature should be added to release notes, it's a good idea to nominate it for addition as soon as it is on the nightly channel.
If your feature is ready for testing on the nightly channel but is behind a feature flag and it isn't planned to ship on Beta/Release soon, please nominate it so that we can expose it to our alpha-testers. The r+ flag will be set by release management only when it ships to beta/release.
The changes that should be included in release notes include:
* New features for end users and web developers
* Important changes for end users and web developers
* Important stability and security fixes
* Important system requirements changes (ex: end of support for an OS version)
* New locales
== How to nominate a bug for release notes addition? ==
=== Nomination in Bugzilla ===
1. '''Nominate a bug'''. Go to a bug in [https://bugzilla.mozilla.org Bugzilla], and nominate fixes or changes for release notes. Expand the "Tracking Flags" section. Then set the relnote-firefox: flag to "?". Release management checks this flag regularly.
A form will pop up in the Bugzilla comments box, asking for your suggested wording for the note and an optional URL to link to further documentation.
2. '''Explain the fix'''. If your fix or another project should be in release notes, tell us what it did, what it means, and what the users and tech press should know. Details are very useful here.
A [https://youtu.be/G6VeZyOP_Rk short video] showing the above process.
Note that most of the changes impacting web developers (tooling, web standard support, and new technologies) are documented on MDN which has specific pages for releases aimed at developers. The MDN team tracks these bugs with the dev-doc-needed keyword.
=== The relnote-firefox tracking flag values ===
{| class="wikitable"
|+ “relnote-firefox” tracking flag values and their meaning
|-
| --- || This bug has not been nominated for inclusion in Firefox release notes
|-
| ?  || This bug has been nominated for inclusion in Firefox release notes. <br>Please fill out the template so as to help release-drivers with formulating the actual release note content.
|-
| X+  || Release Management have determined this bug will be included in Firefox X release notes.
|-
|}


== Gathering of notes during the cycle ==
== Gathering of notes during the cycle ==
273

edits