canmove, Confirmed users
901
edits
ExposureGuidelines: Difference between revisions
Add email templates
(Add email templates) |
|||
| Line 43: | Line 43: | ||
If your work is going to expose a new web API to the web or non-trivially change an existing API, it is requested that you follow these steps: | If your work is going to expose a new web API to the web or non-trivially change an existing API, it is requested that you follow these steps: | ||
# Email [https://lists.mozilla.org/listinfo/dev-platform dev-platform] declaring your | # Email [https://lists.mozilla.org/listinfo/dev-platform dev-platform] declaring your [[#Intent to Implement|intent to implement]] this API. If you are implementing an API that is working its way through a standards body process such as the W3C's, it's best to email as soon as possible (ie. before [http://www.w3.org/2005/10/Process-20051014/tr#q74 W3C CR status] if possible). | ||
# Implement as normal. Code review rounds will take place, etc. Module owners or their designated peers will provide a super-review for all interface changes. | # Implement as normal. Code review rounds will take place, etc. Module owners or their designated peers will provide a super-review for all interface changes. | ||
# Land potentially disruptive APIs behind a preference which is off by default | # Land potentially disruptive APIs behind a preference which is off by default | ||
==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 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). | ||
=Email templates= | |||
==Intent to Implement== | |||
'''To''': <tt>dev-platform@lists.mozilla.org</tt><br /> | |||
'''Subject''': Intent to implement: <your feature goes here> | |||
''Summary'': [https://en.wikipedia.org/wiki/Elevator_pitch elevator pitch] for the new functionality including benefits to web developers<br /> | |||
''Bug'': link to main implementation tracking bug<br /> | |||
''Link to standard'': if no formal specification exists yet, link to public discussions with other browser vendors<br /> | |||
''Platform coverage'': where will this be available? Android, Desktop, Firefox OS<br /> | |||
''Estimated or target release'': in which version do you want to/plan to release this?<br /> | |||
''Preference behind which this will be implemented'': if applicable, how can interested parties test this before it ships pref'd on by default?<br /> | |||
==Intent to Ship== | |||
'''To''': <tt>dev-platform@lists.mozilla.org</tt><br /> | |||
'''Subject''': Intent to ship: <your feature goes here> | |||
As of <target date> I intend to turn <feature> on by default [<on these platforms>]. It has been developed behind the <pref> preference. | |||
This feature was previously discussed in this "intent to implement" thread: <https://groups.google.com/forum/#!forum/mozilla.dev.platform>. | |||
''Bug to turn on by default'': link to main relevant bug (http://bugz.la/)<br /> | |||
''Link to standard'': note here what has transpired with the specification since your original intent to implement email was sent | |||