Contribution Notes

Some notes on getting started with contributing to Selenium Builder.

Ways to Contribute

• File Bugs
• Give Feedback
• Create a Translation
• Create a Language Exporter
• Create a Plugin
• Fork the project, improve things!

Development 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/sebuilder/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 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/.

Then put this file into the "extensions" folder in your Firefox profile folder. In my case, this is /Users/zar/Library/Application Support/Firefox/Profiles/k3xrgtby.dev/extensions/seleniumbuilder@saucelabs.com.

Once you've restarted Firefox you should be prompted about whether you want to install Builder.

It's also a good idea to create a separate Firefox profile for development purposes. This keeps your normal Firefox usage unaffected by development work.

Next Steps

Then, have a look at the wiki index for documentation on how to do specific things like language exporters or new translations.

If you need any help, feel free to contact.