Skip to content

Latest commit

 

History

History
118 lines (83 loc) · 4.46 KB

CONTRIBUTING.md

File metadata and controls

118 lines (83 loc) · 4.46 KB

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 "help wanted". 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.

Reporting Issues

Please include the following when reporting an issue:

  1. Chrome and OS Version: chrome://version
  2. Vimium Version: chrome://extensions

Installing From Source

Vimium is written in Coffeescript, which compiles to Javascript. To install Vimium from source:

  1. Install Coffeescript.
  2. Run cake build from within your vimium directory. Any coffeescript files you change will now be automatically compiled to Javascript.
  3. Navigate to chrome://extensions
  4. Toggle into Developer Mode
  5. Click on "Load Unpacked Extension..."
  6. Select the Vimium directory.

Development tips

  1. Run cake autobuild to watch for changes to coffee files, and have the .js files automatically regenerated

Running the tests

Our tests use shoulda.js and PhantomJS. To run the tests:

  1. git submodule update --init --recursive -- this pulls in shoulda.js.
  2. Install PhantomJS.
  3. npm install path to install the Node.js Path module, used by the test runner.
  4. cake build to compile *.coffee to *.js
  5. cake test to run the tests.

Code Coverage

You can find out which portions of code need them by looking at our coverage reports. To generate these reports:

  1. Download JSCoverage or brew install jscoverage
  2. npm install temp
  3. cake coverage will 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.

Coding Style

  • We follow the recommendations from this style guide.

  • We follow two major differences from this style guide:

    • Wrap lines at 110 characters instead of 80.
    • Use double-quoted strings by default.

  • When writing comments, uppercase the first letter of your sentence, and put a period at the end.

  • If you have a short conditional, feel free to put it on one line:

    # No
if i < 10
  return

# Yes
return if i < 10

Pull Requests

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.

What makes for a good feature request/contribution to Vimium?

Good features:

  • Useful for lots of Vimium users
  • Require no/little documentation
  • Useful without configuration
  • Intuitive or leverage strong convention from Vim
  • Work robustly on most/all sites

Less-good features:

  • Are very niche, and so aren't useful for many Vimium users
  • Require explanation
  • Require configuration before it becomes useful
  • Unintuitive, or they don't leverage a strong convention from Vim
  • Might be flaky and don't work in many cases

We use these guidelines, in addition to the code complexity, when deciding whether to merge in a pull request.

If you're worried that a feature you plan to build won't be a good fit for core Vimium, just open a github issue for discussion or send an email to the Vimium mailing list.

How to release Vimium to the Chrome Store

This process is currently only done by Phil or Ilya.

  1. Increment the version number in manifest.json

  2. Update the Changelog in README.md

    You can see a summary of commits since the last version: git log --oneline v1.45..

  3. Push your commits

  4. Create a git tag for this newly released version

     git tag -a v1.45 -m "v1.45 release"

  5. Run cake package

  6. Take the distributable found in dist and upload it here

  7. Update the description in the Chrome store to include the latest version's release notes

  8. Celebrate