aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorPhil Crosby2014-07-20 16:36:17 -0700
committerPhil Crosby2014-07-20 16:36:17 -0700
commit3c635526d1c98dda4fe310e00b58528d36ad9d97 (patch)
tree7af5196c05ceecd3d319f215b701eff6aee3d153
parentc3c70cac97413796cd9d4e82c07cf11a5ec8ab9c (diff)
downloadvimium-3c635526d1c98dda4fe310e00b58528d36ad9d97.tar.bz2
Add a tip to run cake autobuild when hacking on vimium
-rw-r--r--CONTRIBUTING.md14
1 files changed, 10 insertions, 4 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 21cdb98b..258d86f2 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,10 +1,11 @@
# 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.
+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](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.
## Reporting Issues
@@ -34,6 +35,11 @@ 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