# example-addon-repo

**Repository Path**: mirrors_mozilla/example-addon-repo

## Basic Information

- **Project Name**: example-addon-repo
- **Description**: Example repository with templates and good practices for creating an add-on in Firefox.
- **Primary Language**: Unknown
- **License**: MPL-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-08-22
- **Last Updated**: 2026-03-21

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

[![Coverage Status](https://coveralls.io/repos/github/mozilla/example-addon-repo/badge.svg)](https://coveralls.io/github/mozilla/example-addon-repo)

This repository is intended as an example repository containing templates and good
practices for creating an add-on for Firefox. This could be a general add-on, or
a system add-on built in a separate repository to mozilla-central.

This repository is based on WebExtensions, which are the way forward for extensions
in Firefox. There are a few issues with WebExtensions and SystemAddons, please see
the Issues for more detail.

# Aims

The aim is to bring together tools and services we've used on other system add-ons
(e.g. Hello), into a template/example repository, so that new projects can come
along and get a infrastructure together quickly, and be up and running with code,
test suites, coverage etc quickly.

# Bits currently missing

* Integration with m-c.

# Issues

Please see the [issues list](https://github.com/mozilla/example-addon-repo/issues)

# Documentation

It is intended that all parts of this repository have at least outline
documentation. If you find any parts that are missing, please file an issue or
create a PR.

* [Building, running code and tests](docs/Developing.md)
* [Keeping modules up to date via automated services](docs/ModulesUpdating.md)
* Testing
  * [Linting](docs/Linting.md)
  * [Unit Tests](docs/UnitTests.md)
  * [Functional Tests](docs/Functional.md)
  * [Continous Integration via Taskcluster](docs/Taskcluster.md)