DEPRECATED. Please use https://github.com/mozilla/normandy-nextgen-study-example instead (Old description: Example Firefox Add-on Shield Study built as a Web Extension with Web Extension Experiments to run privileged code where necessary)

addon firefox firefox-shield legacy-addon

Перейти к файлу

Fredrik Wollsén 5a7bf8ce50 Inactivated the introduction bar tests since the bar is known to be broken		2019-03-02 13:15:13 +02:00
.circleci	Updated ci cachebusters to ensure that latest nightly is used	2018-08-31 18:52:58 +03:00
dist	Using dist/ as build output directory	2018-04-25 09:36:30 -05:00
docs	Added docs about retrofitting an existing study add-on to use the template	2019-03-02 00:07:25 +02:00
src	Added examples of validation and sending custom telemetry payloads	2019-03-02 00:07:03 +02:00
test	Inactivated the introduction bar tests since the bar is known to be broken	2019-03-02 13:15:13 +02:00
.babelrc	Code coverage for unit tests	2018-06-09 00:34:07 -07:00
.eslintignore	Upgraded to shield utils 5.2.0 + ported over improvements from the jestr study	2019-01-31 00:51:32 +01:00
.eslintrc.js	Synced eslint rules with utils eslint	2018-06-21 11:28:41 +03:00
.gitignore	Upgraded to shield utils 5.2.0 + ported over improvements from the jestr study	2019-01-31 00:51:32 +01:00
LICENSE	Added default license file to template	2018-03-09 23:23:16 +02:00
README.md	Replaced the link to the shield wiki page with the up to date mana page about add-on experiments	2019-03-02 00:13:56 +02:00
karma.conf.js	Producing trace-level geckodriver logs in test/results/logs - for debugging failing functional tests in CI	2018-07-29 20:17:14 +03:00
package-lock.json	Npm audit fix	2019-03-01 12:13:58 +02:00
package.json	Format code after npm run generate	2019-03-01 12:14:27 +02:00
run-firefox.js	Added code to npm run test:manual updating the TELEMETRY.md example ping sequence	2019-03-01 23:47:17 +02:00
web-ext-config.js	A bit easier docs on using a specific variation	2019-03-01 23:49:17 +02:00

README.md

Shield Studies Add-On Template

About This Repository

This repository is intended as an example repository containing templates and good practices for creating a Add-On Experiments for Firefox.

See TEMPLATE.md for more details on how to use the template. Note: Remove this section after you have cloned/merged the template to your own study add-on repo.

Seeing the add-on in action

See TESTPLAN.md for more details on how to get the add-on installed and tested.

Data Collected / Telemetry Pings

See TELEMETRY.md for more details on what pings are sent by this add-on.

Analyzing data

Telemetry pings are loaded into S3 and re:dash. Sample query:

All pings

(OR, if Pioneer, use the below instead)

Telemetry pings are loaded into the encrypted Pioneer pipeline.

Improving this add-on

See DEV.md for more details on how to work with this add-on as a developer.

References

Bugzilla