Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/candy-chat/candy.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMichael Weibel <michael.weibel@gmail.com>2013-12-16 15:54:17 +0400
committerMichael Weibel <michael.weibel@gmail.com>2013-12-16 15:54:17 +0400
commitf3d424d025b58d66a0c178fb426652201832ef2b (patch)
treeefcaae0348466d149e6274dd56a3e7cb0e1631bb /CONTRIBUTING.md
parentbfee0b33f54c7643dd03a25bb2ad89af6e482873 (diff)
Replace Makefile with Gruntfile
- Add package.json for devDependencies (mainly) - Add bower.json for later publishing to bower - Generated from package.json using `grunt sync` - Fix various jshint errors
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md32
1 files changed, 32 insertions, 0 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..f32e9e8
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,32 @@
+# Contributing
+
+## Team members
+
+* Patrick Stadler &middot; [@pstadler](http://twitter.com/pstadler) &middot; <patrick.stadler@gmail.com>
+* Michael Weibel &middot; [@weibelm](htps://twitter.com/weibelm) &middot; <michael.weibel@gmail.com>
+
+## Learn & listen
+
+* [Mailing list](http://groups.google.com/group/candy-chat)
+ * yes, non-gmail users can signup as well
+* [FAQ](https://github.com/candy-chat/candy/wiki/Frequently-Asked-Questions)
+
+## Contributing
+
+You want to help us? **Awesome!**
+
+### How to contribute
+A few hopefully helpful hints to contributing to Candy
+
+1. [Fork](https://help.github.com/articles/fork-a-repo) Candy
+2. Clone your fork
+2. Checkout out `dev` branch (`git checkout dev`) & Update git submodules `git submodule update --init`
+3. Install [Node.js](http://nodejs.org/)
+4. Install [Grunt](http://gruntjs.com/) (`npm install -g grunt-cli`)
+5. Install npm dependencies (`npm install` in candy root directory)
+6. Create a branch based on the `dev` branch (`git checkout -B my-awesome-feature`)
+7. Make your changes & push them back to your fork
+8. Run `grunt jshint` and fix errors
+9. Create a [pull request](https://help.github.com/articles/using-pull-requests)
+
+In case you have any questions, don't hesitate to ask on the [Mailing list](http://groups.google.com/group/candy-chat).