Contributing to Vimium
You'd like to fix a bug or implement a feature? Great! Check out the bugs on our issues tracker, or implement one of the suggestions there that have been tagged 'todo'. If you have a suggestion of your own, start a discussion on the issues tracker or on the mailing list. If it mirrors a similar feature in another browser or in Vim itself, let us know! Once you've picked something to work on, add a comment to the respective issue so others don't duplicate your effort.
Please include the following when reporting an issue:
- Chrome and OS Version:
- Vimium Version:
Installing From Source
- Install Coffeescript.
- Navigate to
- Toggle into Developer Mode
- Click on "Load Unpacked Extension..."
- Select the Vimium directory.
git submodule update --init --recursive-- this pulls in shoulda.js.
- Install PhantomJS.
cake testto run the tests.
Bugs and features are not the only way to contribute -- more tests are always welcome. You can find out which portions of code need them by looking at our coverage reports. To generate these reports:
- Download JSCoverage or
brew install jscoverage
npm install temp
cake coveragewill generate a coverage report in the form of a JSON file (
jscoverage.json), which can then be viewed using jscoverage-report. See jscoverage-report's README for more details.
When you're done with your changes, send us a pull request on Github. Feel free to include a change to the CREDITS file with your patch.
- Follow the style already present in the file.
- Ensure your lines don't exceed 110 characters.