Shield Studies Add-On Template

March 31, 2019 ยท View on GitHub

CircleCI badge Coverage Status

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

See TEMPLATE.md for more details on how to use the template. Note: Remove or adapt this text 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:

(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