Contribution Notes

Some notes on getting started with developing on Se Builder.

Setup

The first thing you'll want to do is to clone the repo to your machine. You can do this by invoking (assuming you have git installed)

git clone git://github.com/admc/se-builder.git

This will download a local copy of se-builder. If you don't have git installed, you download the source as a zip from the GitHub page.

Next, you will want to tell Firefox to treat this repo as an installed extension. The benefit of this is that you can make changes to Builder, and they will be available upon restarting Firefox. There is no need to recreate an XPI each time.

To do this, go to the "extensions" folder in your Firefox profile folder, and create a text file called seleniumbuilder@saucelabs.com, containing a single line that is the absolute path to the "seleniumbuilder" folder inside the repo. For example, on my setup, this line is /Users/zar/Projects/SeBuilder/se-builder/se-builder/seleniumbuilder/. Once you've restarted Firefox you should be prompted about whether you want to install Builder.

Creating a new language formatter

Language formatters live in

se-builder/seleniumbuilder/chrome/content/html/js/builder/selenium2/io/formats/

and are loaded by

se-builder/seleniumbuilder/chrome/content/html/js/loader.js

So to create a new language formatter, add a file called format.js into the formats folder, and add a line in loader.js to tell Builder to read it in.