www.aleph1.co.uk Git - yaffs-website/blob - vendor/enyo/dropzone/CONTRIBUTING.md

   1 Contribute
   2 ==========
   3
   4
   5 > I have changed my branching model recently (November 2013)! Previously
   6 > the latest version was always in develop, and pull request had to be
   7 > made on this branch. This is no longer the case!
   8
   9
  10 The latest version is always in the **[master](https://github.com/enyo/dropzone)**
  11 branch.
  12
  13
  14 > Please provide a test for any new feature (see the [testing section](#testing) below).
  15
  16
  17 Communicate
  18 -----------
  19
  20 Before you start implementing new features, please create an issue about
  21 it first and discuss your intent.
  22
  23 It might be something that someone else is already implementing or that
  24 goes against the concepts of Dropzone, and I really hate rejecting pull
  25 requests others spent hours writing on.
  26
  27
  28 Developer Dependencies
  29 ----------------------
  30
  31 The first thing you need to do, is to install the developer dependencies:
  32
  33 ```bash
  34 $ npm install
  35 ```
  36
  37 This will install all the tools you need to compile the source files and to test
  38 the library.
  39
  40
  41 Coffeescript & Sass (-> Javascript & CSS)
  42 ------------------------------------------
  43
  44 Dropzone is written in [Coffeescript](http://coffeescript.org) and
  45 [Sass](http://sass-lang.com/) so *do not* make
  46 changes to the Javascript or CSS files
  47
  48 **I will not merge requests written in Javascript or CSS.**
  49
  50 Please don't include compiled `.js` or `.css` files in your pull requests but only
  51 `.coffee` or `.scss` files. That way pull requests aren't polluted and I can see
  52 immediately what you changed.
  53
  54
  55 To build the library use [grunt](http://gruntjs.com).
  56
  57 ```bash
  58 $ grunt -h # Displays available options
  59 $ grunt # compiles all coffeescript and stylus files
  60 $ grunt watch # watches for changes and builds on the fly
  61 ```
  62
  63 > I recommend using `grunt watch` when you begin developing. This way you can't
  64 > forget to compile the source files and will avoid headaches.
  65
  66
  67 Testing
  68 -------
  69
  70 To test the library, open `test/test.html` in your browser or type `npm test`
  71 which will run the tests in your console in a headless browser.
  72
  73 The tests are also written in coffeescript in the `test/test.coffee` file,
  74 and compiled with `grunt js` or `grunt watch`.
  75
  76
  77 * Thanks for contributing!*
  78