forked from philc/vimium
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Format and add instructions for Reporting Issues to CONTRIBUTING
- Loading branch information
1 parent
fedb5eb
commit 23943ea
Showing
2 changed files
with
41 additions
and
23 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,32 +1,55 @@ | ||
# 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](http://groups.google.com/group/vimium-dev?hl=en). 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. | ||
|
||
Vimium is written in Coffeescript, which compiles to Javascript. To build Vimium from source: | ||
## Reporting Issues | ||
|
||
Please include the following when reporting an issue: | ||
|
||
1. Chrome and OS Version: `chrome://version` | ||
1. Vimium Version: `chrome://extensions` | ||
|
||
## Installing From Source | ||
|
||
Vimium is written in Coffeescript, which compiles to Javascript. To | ||
install Vimium from source: | ||
|
||
1. Install [Coffeescript](http://coffeescript.org/#installation). | ||
2. Run `cake autobuild` from within your vimium directory. Any coffeescript files you change will now be automatically compiled to Javascript. | ||
1. Install [Coffeescript](http://coffeescript.org/#installation). | ||
1. Run `cake build` from within your vimium directory. Any coffeescript files you change will now be automatically compiled to Javascript. | ||
1. Navigate to `chrome://extensions` | ||
1. Toggle into Developer Mode | ||
1. Click on "Load Unpacked Extension..." | ||
1. Select the Vimium directory. | ||
|
||
Our tests use [shoulda.js](https://github.com/philc/shoulda.js) and [PhantomJS](http://phantomjs.org/). To run | ||
the tests: | ||
## Tests | ||
|
||
1. `git submodule update --init --recursive` -- this pulls in shoulda.js. | ||
2. [Install PhantomJS.](http://phantomjs.org/download.html) | ||
3. `cake test` to run the tests. | ||
Our tests use [shoulda.js](https://github.com/philc/shoulda.js) and [PhantomJS](http://phantomjs.org/). To run the tests: | ||
|
||
1. `git submodule update --init --recursive` -- this pulls in shoulda.js. | ||
1. [Install PhantomJS.](http://phantomjs.org/download.html) | ||
1. `cake test` to run the tests. | ||
|
||
## Code Coverage | ||
|
||
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: | ||
|
||
1. Download [JSCoverage](http://siliconforks.com/jscoverage/download.html) 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](https://github.com/int3/jscoverage-report). See | ||
jscoverage-report's [README](https://github.com/int3/jscoverage-report#jscoverage-report) for more details. | ||
1. Download [JSCoverage](http://siliconforks.com/jscoverage/download.html) or `brew install jscoverage` | ||
1. `npm install temp` | ||
1. `cake coverage` will generate a coverage report in the form of a JSON file (`jscoverage.json`), which can | ||
then be viewed using [jscoverage-report](https://github.com/int3/jscoverage-report). See | ||
jscoverage-report's [README](https://github.com/int3/jscoverage-report#jscoverage-report) for more details. | ||
|
||
## 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. | ||
|
||
A few coding style guidelines: 1) follow the style already present in the file, 2) ensure your lines | ||
don't exceed 110 characters. | ||
## Coding Style | ||
|
||
* Follow the style already present in the file. | ||
* Ensure your lines don't exceed 110 characters. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters