Permalink
Browse files

Move Contributing information from README to CONTRIBUTING.md

  • Loading branch information...
1 parent 846cc9f commit fedb5ebbea6168a89e50ce952ddb149e8ced6ee0 @christophermanning christophermanning committed Dec 10, 2012
Showing with 33 additions and 32 deletions.
  1. +32 −0 CONTRIBUTING.md
  2. +1 −32 README.markdown
View
@@ -0,0 +1,32 @@
+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:
+
+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.
+
+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.
+2. [Install PhantomJS.](http://phantomjs.org/download.html)
+3. `cake test` to 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:
+
+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.
+
+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.
View
@@ -130,38 +130,7 @@ Shifts are automatically detected so, for example, `<c-&>` corresponds to ctrl+s
Contributing
------------
-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:
-
-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.
-
-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.
-2. [Install PhantomJS.](http://phantomjs.org/download.html)
-3. `cake test` to 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:
-
-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.
-
-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.
+Please see [CONTRIBUTING.md](https://github.com/philc/vimium/blob/master/CONTRIBUTING.md) for details.
Release Notes
-------------

0 comments on commit fedb5eb

Please sign in to comment.