diff options
| author | Phil Crosby | 2014-07-20 16:54:21 -0700 |
|---|---|---|
| committer | Phil Crosby | 2014-07-20 16:54:21 -0700 |
| commit | 8c8e474a2c178ea82d5cf6f60c4d39acf2fd8263 (patch) | |
| tree | 3cfbae2e5eef42f413ab7b7b0796cdde41136cc8 /CONTRIBUTING.md | |
| parent | 3a05a6c0375db6ef6021602f5fc2d97a63966c42 (diff) | |
| download | vimium-8c8e474a2c178ea82d5cf6f60c4d39acf2fd8263.tar.bz2 | |
Reshuffle the contributing.md a bit
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 26 |
1 files changed, 13 insertions, 13 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 258d86f2..b2df1a7f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -26,7 +26,12 @@ install Vimium from source: 1. Click on "Load Unpacked Extension..." 1. Select the Vimium directory. -## Tests +## 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](https://github.com/philc/shoulda.js) and [PhantomJS](http://phantomjs.org/). To run the tests: @@ -35,15 +40,10 @@ Our tests use [shoulda.js](https://github.com/philc/shoulda.js) and [PhantomJS]( 1. `cake build` to compile `*.coffee` to `*.js` 1. `cake test` to run the tests. -## Development tips - - 1. Run `cake autobuild` to watch for changes to coffee files, and have the .js files automatically - regenerated - ## 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: +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` 1. `npm install temp` @@ -51,11 +51,6 @@ portions of code need them by looking at our coverage reports. To generate these 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. - ## Coding Style * We follow the recommendations from @@ -63,3 +58,8 @@ CREDITS file with your patch. * We follow two major differences from this style guide: * Wrap lines at 110 characters instead of 80. * Use double-quoted strings by default. + +## 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. |