Skip to content

Latest commit

 

History

History
46 lines (34 loc) · 2.28 KB

CONTRIBUTING.md

File metadata and controls

46 lines (34 loc) · 2.28 KB
Raw

Contributing

Team members

Learn & listen

Contributing

You want to help us? Awesome!

How to contribute

A few hopefully helpful hints to contributing to Candy

Using vagrant

  1. Fork Candy
  2. Install Vagrant
  3. Follow instructions for Candy 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)
  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
  8. Create a pull request

On your own machine

Please note that you should have a working XMPP server to test your changes (the vagrant way does already have a working XMPP server).

  1. Fork Candy
  2. Clone your fork
  3. Checkout out dev branch (git checkout dev) & Update git submodules git submodule update --init
  4. Install Node.js
  5. Install Grunt (npm install -g grunt-cli)
  6. Install npm dependencies (npm install in candy root directory)
  7. Create a branch based on the dev branch (git checkout -B my-awesome-feature)
  8. Run grunt watch to automatically run jshint (syntax checker) and the build of candy.bundle.js and candy.min.js while developing.
  9. Make your changes, fix eventual jshint errors & push them back to your fork
  10. Create a pull request

In case you have any questions, don't hesitate to ask on the Mailing list.