diff --git a/microsoft-edge/extensions/developer-guide/best-practices.md b/microsoft-edge/extensions/developer-guide/best-practices.md index 034f3c20f7..ac08ce5735 100644 --- a/microsoft-edge/extensions/developer-guide/best-practices.md +++ b/microsoft-edge/extensions/developer-guide/best-practices.md @@ -6,24 +6,87 @@ ms.author: msedgedevrel ms.topic: conceptual ms.service: microsoft-edge ms.subservice: extensions -ms.date: 11/20/2023 +ms.date: 09/22/2025 --- # Best practices for extensions -Follow these Best Practices to implement your extension and list it at [Microsoft Edge Add-ons](https://microsoftedge.microsoft.com). +Follow these best practices to implement your extension and list it at [Microsoft Edge Add-ons](https://microsoftedge.microsoft.com). Build an extension that conforms to Microsoft's standards for security, privacy, performance, and user experience. These principles help ensure your extension is safe, reliable, and valuable to users. + +The Microsoft Edge extensions team continues to gather feedback from developers and users to evolve these best practices. To ensure that your extension remains compliant and competitive, review this guidance regularly. + +Meeting these guidelines doesn't guarantee that your extension will receive the **Featured** badge; see [The Featured badge](../index.md#the-featured-badge) in _Overview of Microsoft Edge extensions_. + +Follow these best practices, to improve the quality, reliability, and user experience of your extension, and to maximize your extension's visibility. + + + +## Security + +* Make sure that your extension doesn't pose any security threats to users. + +* Request only the permissions that are necessary for core functionality. + +* Use secure coding practices, and avoid third-party libraries with known vulnerabilities. + +* Respond promptly to any flagged issues. + + + +## Privacy + +* Handle user data responsibly and in accordance with your published privacy policy. + +* Clearly disclose what data is collected and how it is used. + +* Avoid tracking or fingerprinting users without explicit consent. + + + +## User experience + +* Provide a clean, intuitive, and responsive interface. + +* Avoid disruptive ads, pop-ups, or misleading prompts. + +* Ensure the extension integrates seamlessly into the browsing experience. + + + +## Store listing + +* Provide clear and concise descriptions, to set accurate user expectations. + +* Include high-quality screenshots that reflect the actual user experience. -## Design a high-quality extension +## Performance and stability -Build an extension that conforms to Microsoft's standards for security, privacy, transparency, and user experience. +* Minimize background activity and memory usage. -**Security**: Make sure that your extension doesn't pose any security threats to users. +* Avoid crashes, freezes, or excessive CPU consumption. -**Privacy**: Make sure that your extension handles user data appropriately. +* Test your extension across different versions of Microsoft Edge and supported platforms. -**User experience**: Make sure that your extension provides a clean, intuitive, and seamless user experience on the web without ads that can be interruptive. +* Refer to [Minimize an extension's impact on page load time](./minimize-page-load-time-impact.md). + + + +## Responsiveness to user feedback + +* Monitor user reviews, and respond constructively. + +* Address bugs and usability issues in a timely manner. + +* Maintain a regular update cadence, to improve reliability and user trust. + + + +## See also + -**Store listing**: Make sure that your extension's store listing sets correct user expectations and clearly communicates what the extension does. +* [The Featured badge](../index.md#the-featured-badge) in _Overview of Microsoft Edge extensions_. +* [Minimize an extension's impact on page load time](./minimize-page-load-time-impact.md) -We'll continue gathering input about Developer experiences with extensions, and updating these Best Practices. +External: +* [Microsoft Edge Add-ons](https://microsoftedge.microsoft.com) diff --git a/microsoft-edge/extensions/index-images/featured-badge-on-page.png b/microsoft-edge/extensions/index-images/featured-badge-on-page.png new file mode 100644 index 0000000000..36ff46d130 Binary files /dev/null and b/microsoft-edge/extensions/index-images/featured-badge-on-page.png differ diff --git a/microsoft-edge/extensions/index-images/featured-badge.png b/microsoft-edge/extensions/index-images/featured-badge.png index 76cdaa82ac..52436e9f73 100644 Binary files a/microsoft-edge/extensions/index-images/featured-badge.png and b/microsoft-edge/extensions/index-images/featured-badge.png differ diff --git a/microsoft-edge/extensions/index.md b/microsoft-edge/extensions/index.md index 5df38de425..635611ae84 100644 --- a/microsoft-edge/extensions/index.md +++ b/microsoft-edge/extensions/index.md @@ -25,7 +25,7 @@ An extension should include at least the following features: To work directly with a specific part of the browser, such as a window or tab, you must send API requests, and must often reference the browser by name. - +A Microsoft Edge extension: ![A Microsoft Edge extension](./index-images/example-extension-screenshot.png) @@ -132,19 +132,49 @@ After you've successfully submitted your extension, your extension undergoes a r ## The Featured badge -A **Featured** badge is displayed on some extension listings at [Microsoft Edge Add-ons](https://microsoftedge.microsoft.com). The **Featured** badge indicates that the extension has been determined to follow Microsoft's recommended best practices related to security, privacy, transparency, and user experience. +Extensions are curated to help users discover trustworthy and high-performing extensions. The **Featured** badge at [Microsoft Edge Add-ons](https://microsoftedge.microsoft.com) highlights extensions that meet a high bar of quality, security, and user experience. -![The Featured badge to the right of the extension name](./index-images/featured-badge.png) +![The Featured badge](./index-images/featured-badge.png) -When you hover on a **Featured** badge, the tooltip reads: **This extension follows all of Microsoft's recommended practices and has been verified**. +The **Featured** badge is awarded to select extensions that align with [Best practices for extensions](./developer-guide/best-practices.md). When you hover over the **Featured** badge, the tooltip reads: **This extension follows all of Microsoft's recommended practices and has been verified.** -For example, the [Microsoft Editor: Spelling & Grammar Checker](https://microsoftedge.microsoft.com/addons/detail/microsoft-editor-spellin/hokifickgkhplphjiodbggjmoafhignh) extension has a **Featured** badge at Microsoft Edge Add-ons. +For example, the [Microsoft Editor: Spelling & Grammar Checker](https://microsoftedge.microsoft.com/addons/detail/microsoft-editor-spellin/hokifickgkhplphjiodbggjmoafhignh) extension has a **Featured** badge: -The Microsoft Edge extensions team reviews each extension for adherence to [Best practices for extensions](./developer-guide/best-practices.md) before granting the extension a **Featured** badge. Badged extensions are curated solely for the purpose of providing Microsoft Edge users with secure browsing tools and high-quality experiences. Developers cannot pay to receive a **Featured** badge for an extension. +![The Featured badge to the right of the extension name](./index-images/featured-badge-on-page.png) -To help protect your browser settings, extensions that don't comply with the Best Practices for extensions are not badged. -Just because an extension doesn't have a **Featured** badge, doesn't mean the extension is unsafe. It simply means that the extension doesn't meet Microsoft's security and quality standards to be badged as **Featured**. + +#### What the Featured badge represents + +The **Featured** badge indicates that: + +* The extension aligns with Microsoft's best practices for security, privacy, performance, and user experience. + +* The extension has been reviewed and selected through an automated system. + +* The extension offers a reliable and high-quality experience for Microsoft Edge users. + +The **Featured** badge is not a judgment of safety. An extension that doesn't have the **Featured** badge is not necessarily unsafe; the extension simply doesn't meet the current threshold for Featured status. + + + +#### Why the Featured badge might be revoked + +The **Featured** badge isn't permanent. An extension might lose the **Featured** badge if the extension no longer meets the evolving standards, or if the extension's quality signals degrade over time. + +To maintain a high-quality ecosystem, Microsoft periodically re-evaluates all badged extensions. A **Featured** badge might be removed due to: + +* Decline in user experience or performance metrics. + +* Outdated or incomplete store listing information. + +* Security or privacy concerns. + +* Changes in Microsoft's evaluation criteria. + +All decisions about the **Featured** badge are final and not subject to individual review. There is no manual application or appeal process. The **Featured** badge is awarded and revoked based on internal evaluation criteria and tooling. + +To improve your extension's quality and eligibility for the **Featured** badge, see [Best practices for extensions](./developer-guide/best-practices.md).