History

harvey186 33460cf494 search_engine		2023-12-25 10:19:33 +01:00
..
build	search_engine	2023-12-25 10:19:33 +01:00
src	first commit	2023-11-28 09:10:03 +01:00
README.md	first commit	2023-11-28 09:10:03 +01:00
build.gradle	first commit	2023-11-28 09:10:03 +01:00
proguard-rules.pro	first commit	2023-11-28 09:10:03 +01:00

README.md

WebCompat Reporter

A feature that enables users to report site issues to Mozilla's Web Compatibility team for further diagnosis.

Usage

Setting up the dependency

Use Gradle to download the library from maven.mozilla.org (Setup repository):

implementation "org.mozilla.components:feature-webcompat-reporter:{latest-version}"

Install WebExtension

To install the WebExtension, run

WebCompatReporterFeature.install(engine)

Please make sure to only run this once, as the feature itself does not check if the extension is already installed.

Providing the browser-XXX label for reports

The install function has an optional second parameter, productName. This allows reports to be labelled using the correct broswer-XXX label on webcompat.com. For example,

WebCompatReporterFeature.install(engine, "fenix")

would add the browser-fenix label to the report. Note that simply inventing new values here does not work, as each product name has to be safelisted by the WebCompat team on webcompat.com, so please get in touch when you need to add a new product name.

License

This Source Code Form is subject to the terms of the Mozilla Public
License, v. 2.0. If a copy of the MPL was not distributed with this
file, You can obtain one at http://mozilla.org/MPL/2.0/