improve readme & add contributing.md

CONTRIBUTING.md

@@ -0,0 +1,30 @@
+# Contributing
+
+Contributions are **welcome** and will be fully **credited**.
+
+We accept contributions via Pull Requests on [Github](https://github.com/voidberg/html5sortable).
+
+
+## Pull Requests
+
+- **[JSCS Google Style](https://google-styleguide.googlecode.com/svn/trunk/javascriptguide.xml)** - Please follow the [google javaScript styleguide](https://google-styleguide.googlecode.com/svn/trunk/javascriptguide.xml), this will be checked by the test suit.
+
+- **Add tests!** - Your patch won't be accepted if it doesn't have tests.
+
+- **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date.
+
+- **Create feature branches** - Don't ask us to pull from your master branch.
+
+- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.
+
+- **Send coherent history** - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please [squash them](http://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages) before submitting.
+
+
+## Running Tests
+
+``` bash
+$ npm test
+```
+
+
+**Happy coding**!

README.md

@@ -1,7 +1,7 @@
 HTML5 Sortable jQuery Plugin
 ============================
 
-![Build Status](https://img.shields.io/travis/voidberg/html5sortable/master.svg?style=flat-square) ![Coverage Status](https://img.shields.io/coveralls/voidberg/html5sortable/master.svg?style=flat-square) ![Git Release](https://img.shields.io/github/release/voidberg/html5sortable.svg?style=flat-square) ![Bower](https://img.shields.io/bower/v/html.sortable.svg?style=flat-square) ![NPM](https://img.shields.io/npm/v/html5sortable.svg?style=flat-square)
+[![Build Status](https://img.shields.io/travis/voidberg/html5sortable/master.svg?style=flat-square)](https://travis-ci.org/voidberg/html5sortable) [![Coverage Status](https://img.shields.io/coveralls/voidberg/html5sortable/master.svg?style=flat-square)](https://coveralls.io/github/voidberg/html5sortable) [![Git Release](https://img.shields.io/github/release/voidberg/html5sortable.svg?style=flat-square)](https://github.com/voidberg/html5sortable/releases) ![Bower](https://img.shields.io/bower/v/html.sortable.svg?style=flat-square) [![NPM](https://img.shields.io/npm/v/html5sortable.svg?style=flat-square)](https://www.npmjs.com/package/html5sortable)
 
 > **Lightweight jQuery plugin to create sortable lists and grids using native HTML5 drag and drop API.**
 
@@ -40,36 +40,20 @@ bower install
 ```
 
 # Build it / Hack it
-
-**1. Node package manager (npm)**
+**1. Clone and install the project**
 You will need `npm`, choose any way you like to [install npm](https://github.com/npm/npm#super-easy-install).
-
-**2. Clone and install the project**
 ```
 git clone https://github.com/voidberg/html5sortable
 cd html5sortable
 npm install && bower install
 ```
 
-**3. Commit**
-If you send a *pull request* make sure it passes the tests & linting. Please do **NOT** bump the version number.
+**2. Send a PR**
+If you send a *pull request* make sure it passes the tests & linting. Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
 ```
 npm test
 ```
 
-> *Note: At the moment you will get the following warnings, if your PR does not add any other warning, it is considered to have passed:*
-- 2x This function has too many statements. (for src/html.sortable.js)
-- 2x Line must be at most 80 characters (for src/html.sortable.js)
-
-> *We are going to fix those linting issues in the near future.*
-
-**4. Merging PRs and building (only if you have commit rights)**
-
-After merging a PR run the following command to build the minified versions and bump the version number.
-```
-npm run build
-```
-
 
 # Usage
 
@@ -256,22 +240,15 @@ $scope.sortableCallback = function (startModel, destModel, start, end) {
 ```
 See the [examples](#examples) for more information.
 
-## Authors
-
-Original code by Ali Farhadi. This version is mantained by [Alexandru Badiu](http://ctrlz.ro) & [Lukas Oppermann](http://vea.re).
+## Authors & Contributors
 
-## Contributors
+This version is mantained by [Alexandru Badiu](http://ctrlz.ro) & [Lukas Oppermann](http://vea.re).
 
-Thanks to all the people who contributed fixed and improvments. To get a full list of contributors, check out the [AUTHORS file](/AUTHORS).
+Thanks to [all contributors](../../contributors) who contributed fixes and improvements.
 
 ## Contributing
-When sending pull requests make sure to only include changes that directly relate to the fix/feature you are adding and also start a pull request from a freshly cloned copy of the repo to make it easy to merge.
-
-Please always rebase to a single commit with a descriptive name and an explanation of why what was changed.
-
-If you sent a pull request and it got merged, your name will automatically be added to the `AUTHORS` file with the next release.
 
-**NOTE:** Please do **NOT** add your name to the `AUTHORS` file and **do NOT bump the version** as this will be done automatically.
+Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
 
 ## Comment your code
 Your code should be as self-documenting as possible, but because this is an open source project with multiple contributors please add comments whenever possible.

gulpfile.js

@@ -116,8 +116,7 @@ gulp.task('add-files', ['bump-version'], function() {
   var v = require('./package.json').version;
   return gulp.src([])
     .pipe(shell([
-      "git shortlog -ns master | awk '$1 >= 1 {print $0}' | cut -d' ' -f2- > AUTHORS",
-      "git add AUTHORS ./package.json ./bower.json ./dist/* && git commit -m 'bump to version v"+v+"'"
+      "git add ./package.json ./bower.json ./dist/* && git commit -m 'bump to version v"+v+"'"
     ]))
 });
 /* tag version */