Developer Guide

Pixel Perfect is an open source project and we are open for patches. If you find an issue, or want a new feature, create a new report in our issue tracker.

Hack on Pixel Perfect

Read following instructions describing how to contribute to the project.

1. Install JPM: npm install jpm -g (read more about installing jpm)
2. Get Pixel Perfect source: git clone https://github.com/firebug/pixel-perfect.git
3. Install required NPM modules: npm install
4. Make changes in the source code
5. Run jpm run -b nightly in the source directory (learn more about jpm commands)
6. Send a pull request (read about using pull requests)

Build XPI

Building the final XPI package is done through JPM.

jpm xpi

Note that jpm is using new bootstrap.js file that is only compatible with Firefox 38+. If you want to support Firefox 37 you need to download previous version of the bootstrap.js from jpm core. You need to check out tag 0.0.5 to get the right version.

Repository Structure

Structure of the extension follows Jetpack standards.

• data HTML pages
• chrome Stylesheets, localization files
• lib Javascript files.
• test Test files

Testing

Pixel Perfect is integrated with Travis (hosted continuous integration service).

In order to run all Pixel Perfect test locally on your machine, type the following command in the source directory:

jpm test

Learn more about this command.

All tests are located within test directory.

Translations

Pixel Perfect translations are maintained on BabelZilla.org. If you want to became a translator create an account on the site and join the Pixel Perfect team! You can also read forum dedicated to Pixel Perfect. If you see an issue with existing translations create a report.

Contact Us

There are several ways how you can reach folks behind this extension

• Newsgroups We are using the same group as for Firebug.
• Issue List Just file a bug (or request for feature) report directly.
• Online Chat Join the Pixel Perfect room

License

Pixel Perfect is based on BSD License.