Contribution guidelines enhancement

FagnerMartinsBrack · FagnerMartinsBrack · commit 9b5607e8302d · 2013-07-05T22:15:44.000-03:00
Closes js-cookiegh-181
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,53 @@
+##Issues
+
+- Report issues or feature requests on [GitHub Issues](https://github.com/carhartl/jquery-cookie/issues).
+- If reporting a bug, please add a [simplified example](http://sscce.org/).
+
+##Pull requests
+- Create a new topic branch for every separate change you make.
+- Create a test case if you are fixing a bug or implementing an important feature.
+- Make sure the build runs successfully.
+
+## Development
+
+###Tools
+We use the following tools for development:
+
+- [Qunit](http://qunitjs.com/) for tests.
+- [NodeJS](http://nodejs.org/download/) required to run grunt and the test server only.
+- [Grunt](http://gruntjs.com/getting-started) for task management.
+
+###Getting started 
+Install [NodeJS](http://nodejs.org/).  
+Install globally grunt-cli using the following command:
+
+    $ npm install -g grunt-cli
+
+Browse to the project root directory and install the dev dependencies:
+
+    $ npm install -d
+
+To execute the build and tests run the following command in the root of the project:
+
+    $ grunt
+
+You should see a green message in the console:
+
+    Done, without errors.
+
+###Tests
+You can also run the tests in the browser.  
+Start a test server from the project root:
+
+    $ node test/server.js
+
+Open the following URL in a browser:
+
+    $ open http://0.0.0.0:8124/test/index.html
+
+_Note: we recommend cleaning all the browser cookies before running the tests, that can avoid false positive failures._
+
+###Automatic build
+You can build automatically after a file change using the following command:
+
+    $ grunt watch
diff --git a/README.md b/README.md
@@ -96,26 +96,8 @@ Define the domain where the cookie is valid. Default: domain of page where the c
 
 If true, the cookie transmission requires a secure protocol (https). Default: `false`.
 
-## Tests
-
-Requires Node. Startup server:
-
-    $ node test/server.js
-
-Open in browser:
-
-    $ open http://0.0.0.0:8124/test/index.html
-
-For quick *non cross-browser* testing use grunt, install grunt CLI and project dependencies as outlined in this guide: <http://gruntjs.com/getting-started>, then run:
-    
-    $ grunt
-
-## Development
-
-- Source hosted at [GitHub](https://github.com/carhartl/jquery-cookie)
-- Report issues, questions, feature requests on [GitHub Issues](https://github.com/carhartl/jquery-cookie/issues)
-
-Pull requests are very welcome! Make sure your patches are well tested. Please create a topic branch for every separate change you make.
+##Wanna help?
+Check out the [Contributing Guidelines](CONTRIBUTING.md)
 
 ## Authors
 
