ExposureGuidelines: Difference between revisions

Jump to navigation Jump to search
add guidelines for removing features
(Updating testing section asking about web platform tests)
(add guidelines for removing features)
Line 48: Line 48:
==Turning a preference on by default==
==Turning a preference on by default==
When you are satisfied that your new API is stable enough for exposure to the Web at large (see [[#When is an API ready to be shipped by Gecko?|above]]), it is requested that implementors send another email to dev-platform declaring their [[#Intent to Ship|intent to ship]].  Among other things, this email serves to inform those that are interested in the new API but have not been closely following the implementation bug(s).
When you are satisfied that your new API is stable enough for exposure to the Web at large (see [[#When is an API ready to be shipped by Gecko?|above]]), it is requested that implementors send another email to dev-platform declaring their [[#Intent to Ship|intent to ship]].  Among other things, this email serves to inform those that are interested in the new API but have not been closely following the implementation bug(s).
=Guidelines for removing features=
Occasionally there is a need to remove features. These could be features that are proprietary to Mozilla, were standardized but never got adopted by all browsers, or features that are so bad that all browsers want to get rid of them together.
In order to make this possible while impacting users as little as possible the following steps are to be taken:
* Gather telemetry on the feature.
* Consult dev-platform with an "Intent to unship" that includes the telemetry data.
* Indicate in the developer console whenever the feature is used that it's deprecated and might be removed. It's best to avoid doing this until there's agreement that the feature can be removed (which requires telemetry) as otherwise developers are needlessly spammed in the console.
* Remove the feature when the telemetry data and dev-platform agreement indicate it can be.


=Email templates=
=Email templates=
Line 101: Line 113:


An Intent to Ship requires either a web platform test suite or such issues to be filed explaining why such a test suite is currently impossible or in the progress of being upstreamed.
An Intent to Ship requires either a web platform test suite or such issues to be filed explaining why such a test suite is currently impossible or in the progress of being upstreamed.
==Intent to unship==
'''To''': <tt>dev-platform@lists.mozilla.org</tt><br />
'''Subject''': Intent to unship: <your feature goes here>
<The body of the email should contain rationale, telemetry analysis, links to related discussions if any, and developer console suggestions.>


[[Category:Web APIs]]
[[Category:Web APIs]]
Confirmed users
112

edits

Navigation menu