Release Management/Relnotes rules: Difference between revisions

From MozillaWiki
Jump to navigation Jump to search
(about the relnote keyword)
(Revamp Release notes related wiki page.)
Line 1: Line 1:
'''This document is a draft.'''
This page describes the rules applied by the Release Team about the relnotes flag.
This page describes the rules applied by the Release Team about the relnotes flag.


<big>'''What are release notes?'''</big>
The release notes page lists all the new features, changes or unfixed critical bugs for a specific release of Firefox (desktop/mobile, beta/release, etc).
The release notes page lists all the new features, changes or unfixed critical bugs for a specific release of Firefox (desktop/mobile, beta/release, etc).
Their edition and content are under the responsability of the release team.
Their edition and content are under the responsability of the release team. Release notes from past Firefox releases - https://www.mozilla.org/en-US/firefox/releases/
 
For example:
For example:
* [http://www.mozilla.org/en-US/firefox/27.0.1/releasenotes/ Firefox 27 Desktop release notes]
* [https://www.mozilla.org/en-US/firefox/38.0/releasenotes/ Firefox 38.0 Desktop release notes]
* [http://www.mozilla.org/en-US/mobile/28.0beta/releasenotes/ Firefox 28 Mobile beta release notes]
* [https://www.mozilla.org/en-US/firefox/37.0/releasenotes/ Firefox 37.0 Mobile beta release notes]
 
= User perspective: Adding an item in the release notes =
 
To promote an item to be part of the release notes, the flag ''relnote-firefox'' should be used. This flag can be found in the '''Tracking Flags''' section.


While setting the flag, a description for the release note can be provided. Otherwise, the release team will look that the bug description or the commit message to find a correct description for the release note. No sentence should be used and the description should remain small.
<big>'''relnote-firefox tracking flag'''</big> : It is multi-state flag that currently has several values which indicate whether a bug has been included in firefox release/beta/aurora/nightly release-notes. Bugs nominated for “relnote-firefox” (by setting the flag to “?”) are bugs that are deemed to have a high end-user impact and and should be included in the release notes on firefox release/beta/aurora/nightly release.  


= Release Team Perspective: Changing the relnote-firefox flag =
<big>'''How to decide whether a bug should be included in release notes?'''</big>
The different categories of bugs that should be included in releases notes include:
* New features for end users (example: pocket)
* New features for developers (ex:WebSocket now available in Web Workers)
* New features for user of the developer tools (ex: performances tools)
* New locales
* Important changes for end user (ex: changes in the interface for the android app)
* Important changes for developers or sysadmin


Once a Mozillians has set the ''relnote-firefox'' flag to ''?'', the role of the release manager is to approve or reject its inclusion in the next release notes.
<big>'''“relnote-firefox” tracking flag values''':</big>
* “''?''” This bug has been nominated for inclusion in Firefox release notes. Please fill out the template so as to help release-drivers with formulating the actual release note content.
* “''-''” (minus) - Drivers have determined this bug does not meet the bar for inclusion in release notes. A comment in the bug will explain why.
* “''N+''” - Drivers have determined this bug will be included in FirefoxN release notes.
* “''N+1+''” - Drivers have determined this bug will be included in FirefoxN+1 release notes.
* “''N+2+''” - Drivers have determined this bug will be included in FirefoxN+2 release notes.
* “''N+3+''” - Drivers have determined this bug will be included in FirefoxN+3 release notes.
* “''N+4+''” - Drivers have determined this bug will be included in FirefoxN+4 release notes.  


In case of rejection, the value ''-'' should be set and a comment left to explain the choice.
<big>'''What happens when a bug is accepted for Release Notes documentation?'''</big>
Relevant information from the bug should be added as an item in the [https://nucleus.mozilla.org/ Nucleus database] for a specific release. Look for the field ''Target Milestone'' or ''Version'' to find out in which version it will be available.


In case of acceptation, the item should be insert in the [https://nucleus.mozilla.org/ Nucleus database] for a specific release (look for the field ''Target Milestone'' or ''Version'' to find out in which version it will be available).
Legacy: in the past, the "relnote" keyword was used. This should not be used anymore (it is shared by various projects and does not allow to mark it as processed, etc).
Then, set the relnote-firefox flag to the right version.


Legacy: in the past, the "relnote" keyword was used. This should be used anymore (it is shared by various projects, does not allow to mark it as processed, etc).
<big>'''Categories of release note entries:'''</big>
* New - new features
* Fixed - List of known Issues that have been fixed
* Changed - Important changes to browser interface/behavior that will be valuable for Firefox end-users to know about.
* Developer - Issues that are of special interest to Firefox Developer audience
* HTM5 - Issues related to HTML5
* Unresolved -  List of known issues that are not resolved in this release.




[[category:Release_Management|R]]
[[category:Release_Management|R]]

Revision as of 23:52, 4 June 2015

This page describes the rules applied by the Release Team about the relnotes flag.

What are release notes? The release notes page lists all the new features, changes or unfixed critical bugs for a specific release of Firefox (desktop/mobile, beta/release, etc). Their edition and content are under the responsability of the release team. Release notes from past Firefox releases - https://www.mozilla.org/en-US/firefox/releases/ For example:

relnote-firefox tracking flag : It is multi-state flag that currently has several values which indicate whether a bug has been included in firefox release/beta/aurora/nightly release-notes. Bugs nominated for “relnote-firefox” (by setting the flag to “?”) are bugs that are deemed to have a high end-user impact and and should be included in the release notes on firefox release/beta/aurora/nightly release.

How to decide whether a bug should be included in release notes? The different categories of bugs that should be included in releases notes include:

  • New features for end users (example: pocket)
  • New features for developers (ex:WebSocket now available in Web Workers)
  • New features for user of the developer tools (ex: performances tools)
  • New locales
  • Important changes for end user (ex: changes in the interface for the android app)
  • Important changes for developers or sysadmin

“relnote-firefox” tracking flag values:

  • “?” This bug has been nominated for inclusion in Firefox release notes. Please fill out the template so as to help release-drivers with formulating the actual release note content.
  • “-” (minus) - Drivers have determined this bug does not meet the bar for inclusion in release notes. A comment in the bug will explain why.
  • “N+” - Drivers have determined this bug will be included in FirefoxN release notes.
  • “N+1+” - Drivers have determined this bug will be included in FirefoxN+1 release notes.
  • “N+2+” - Drivers have determined this bug will be included in FirefoxN+2 release notes.
  • “N+3+” - Drivers have determined this bug will be included in FirefoxN+3 release notes.
  • “N+4+” - Drivers have determined this bug will be included in FirefoxN+4 release notes.

What happens when a bug is accepted for Release Notes documentation? Relevant information from the bug should be added as an item in the Nucleus database for a specific release. Look for the field Target Milestone or Version to find out in which version it will be available.

Legacy: in the past, the "relnote" keyword was used. This should not be used anymore (it is shared by various projects and does not allow to mark it as processed, etc).

Categories of release note entries:

  • New - new features
  • Fixed - List of known Issues that have been fixed
  • Changed - Important changes to browser interface/behavior that will be valuable for Firefox end-users to know about.
  • Developer - Issues that are of special interest to Firefox Developer audience
  • HTM5 - Issues related to HTML5
  • Unresolved - List of known issues that are not resolved in this release.
Retrieved from "https://wiki.allizom.org/index.php?title=Release_Management/Relnotes_rules&oldid=1078537"