Difference between revisions of "WebExtensions/NewAPIs"

From MozillaWiki
Jump to: navigation, search
m (newapis)
(Added link to WebExtensions API policy page)
 
Line 7: Line 7:
 
* Join the [https://mail.mozilla.org/listinfo/dev-addons dev-addons mailing list] to find out which APIs are being triaged every week so you can follow along or provide input.
 
* Join the [https://mail.mozilla.org/listinfo/dev-addons dev-addons mailing list] to find out which APIs are being triaged every week so you can follow along or provide input.
  
If none of these options address your situation, you can consider filing an API request. Before you do, please keep in mind:
+
If none of these options address your situation, consider filing an API request. Before you do, please keep in mind:
  
* The goal of WebExtensions is not to support every use case from legacy extensions. In most cases, the functionality you need can be built with WebExtensions APIs, but it requires some re-thinking and modification.
+
* New API must meet the guidelines outlined the [[WebExtensions/policy|WebExtensions API Policy]]. Please review it.
* Generic or very broad bugs are hard to turn into actionable issues. Try to limit the focus if possible.
 
 
* We do try to review all incoming API requests, but it takes time, so please be patient.  
 
* We do try to review all incoming API requests, but it takes time, so please be patient.  
 
* Do a [https://mzl.la/2snQxWS search] to see if the bug exists already.
 
* Do a [https://mzl.la/2snQxWS search] to see if the bug exists already.

Latest revision as of 18:27, 10 November 2017

You want to request a new API for WebExtensions?

Great. But please read through the following before filing a bug:

  • If you are migrating your add-on to WebExtensions, please check this page to see if all the APIs you need are already available.
  • If you don't find what you need, please check the list of approved APIs and add yourself to the bug that applies to you to track its progress.
  • Join the dev-addons mailing list to find out which APIs are being triaged every week so you can follow along or provide input.

If none of these options address your situation, consider filing an API request. Before you do, please keep in mind:

  • New API must meet the guidelines outlined the WebExtensions API Policy. Please review it.
  • We do try to review all incoming API requests, but it takes time, so please be patient.
  • Do a search to see if the bug exists already.
  • Still want to file a new API? You can do so here.

Here are some reference materials you might find helpful: