Skip to content

Latest commit

 

History

History
48 lines (33 loc) · 1.69 KB

CONTRIBUTING.md

File metadata and controls

48 lines (33 loc) · 1.69 KB

PassFF Contributing Guide

Thanks for your interest in contributing to PassFF!

Development

To get started, you'll need to fork and clone the repository.

For development or temporary testing in Firefox, open about:debugging and choose to load the add-on temporarily by selecting the file src/manifest.json in your git working directory. For auto-reloading the extension on changes in a new profile, check out Mozilla's Web-ext. You may also use the Firefox Debugger for faster and easier debugging. Quick introduction to Firefox Debugger.

You'll probably want to enable debug logs. Open the PassFF preferences from the menu or from about:addons and enable the preference "Enable logging to the JavaScript web console".

If you'd like to easily toggle dark mode, you can also add ui.systemUsesDarkTheme as the number 1 in about:config.

Style guide

Please follow these conventions and amend to them when necessary.

Indentation

Two spaces please!

Line length

At most 90 characters.

Semicolons

Always terminate statements with semicolons.

Braces

On the same line as the statement.

// good
if (true) {
  // your code here
}

// bad
if (true)
{
  // your code here
}

Building (only useful for the maintainer, don't do it)

From the project's root directory, execute make VERSION=testing. This will create an XPI file in the project's bin/testing/ directory that you can install in your browser.

Note that Firefox will not accept unsigned extensions unless you deactivate xpinstall.signatures.required in about:config.