diff options
| author | Ben Langfeld <ben@langfeld.me> | 2014-07-28 05:39:17 +0400 |
|---|---|---|
| committer | Ben Langfeld <ben@langfeld.me> | 2014-07-28 23:28:16 +0400 |
| commit | 7ba020d846f47abd24fa1cdf7ed5e1fa72e65660 (patch) | |
| tree | bf58b8abddbdd90fce9b94e2b3e77363274a62e3 /CONTRIBUTING.md | |
| parent | 97c81c1ac54dec32cbf1f88a3850bc64ef204f0f (diff) | |
Merges the Candy dev environment
Comes from https://github.com/candy-chat/vagrant/pull/1.
There's no convincing reason for this to be excluded from the main reason. The Vagrant environment makes working on Candy easier (provides an XMPP server for testing, Selenium & PhantomJS for automated tests and a ready-made NodeJS environment for building.
This excludes candy-plugins for now. We can figure out how that fits later.
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 3 |
1 files changed, 1 insertions, 2 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ae81d1f..bb2c38e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -21,8 +21,7 @@ A few hopefully helpful hints to contributing to Candy #### Using vagrant 1. [Fork](https://help.github.com/articles/fork-a-repo) Candy 2. [Install Vagrant](http://vagrantup.com/) -3. Follow instructions [for Candy Vagrant](https://github.com/candy-chat/vagrant) -4. Change the remote in the `candy` and `candy-plugins` repos: `git remote set-url origin git://github.com/YOURNAME/candy` (or candy-plugins) +3. Run `vagrant up`. 5. Create a branch based on the `dev` branch (`git checkout -B my-awesome-feature`) 6. Run `grunt watch` to automatically run jshint (syntax checker) and the build of `candy.bundle.js` and `candy.min.js` while developing. 7. Make your changes, fix eventual *jshint* errors & push them back to your fork |