Merge branch 'dev'

Author: Franz Josef Kaiser

README.md

@@ -7,15 +7,20 @@
 > A Grunt plugin to help bind Grunt tasks to Git hooks
 
 ## Getting Started
-This plugin requires Grunt `~0.4.1`
+This plugin requires at least Grunt `~0.4.1`
 
-If you haven't used [Grunt](http://gruntjs.com/) before, be sure to check out the [Getting Started](http://gruntjs.com/getting-started) guide, as it explains how to create a [Gruntfile](http://gruntjs.com/sample-gruntfile) as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:
+If you haven't used [Grunt](http://gruntjs.com/) before, be sure to check out the
+[Getting Started](http://gruntjs.com/getting-started) guide, as it explains how to
+create a [Gruntfile](http://gruntjs.com/sample-gruntfile) as well as install and
+use Grunt plugins. Once you're familiar with that process, you may install this
+plugin with this command:
 
 ```shell
 npm install grunt-githooks --save-dev
 ```
 
-Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
+Once the plugin has been installed, it may be enabled inside your
+Gruntfile with this line of JavaScript:
 
 ```js
 grunt.loadNpmTasks('grunt-githooks');
@@ -24,7 +29,8 @@ grunt.loadNpmTasks('grunt-githooks');
 ## The "githooks" task
 
 ### Overview
-In your project's Gruntfile, add a section named `githooks` to the data object passed into `grunt.initConfig()`.
+In your project's Gruntfile, add a section named `githooks` to the data
+object passed into `grunt.initConfig()`.
 
 ```js
 grunt.initConfig({
@@ -44,9 +50,10 @@ grunt.initConfig({
 
 #### Defining a few hooks
 
-Hooks are listed as keys of your target configuration.
-**Any key other than `option`** is considered the name of a hook you want to create.
-The simplest way to define a hook is to provide a **space-separated list of the tasks you want the hook to run as the value**.
+Hooks are listed as keys of your target configuration. **Any key other than
+`option`** is considered the name of a hook you want to create. The simplest way
+to define a hook is to provide a **space-separated list of the tasks you want
+the hook to run as the value**.
 
 For example:
 ```js
@@ -60,12 +67,15 @@ grunt.initConfig({
 });
 ```
 
-The plugin warns you if the name matches one of the [hooks announced in the Git documentation](https://www.kernel.org/pub/software/scm/git/docs/githooks.html).
-It will still create the hook, though, in case Git introduces new hooks in the future.
+The plugin warns you if the name matches one of the
+[hooks announced in the Git documentation](https://www.kernel.org/pub/software/scm/git/docs/githooks.html).
+It will still create the hook, though, in case Git introduces new hooks
+in the future.
 
 #### Hook specific options
 
-If you need to override a few options for a given hook only, you can *use an Object instead of a String*.
+If you need to override a few options for a given hook only, you can *use an
+Object instead of a String*.
 The `taskNames` property will then correspond to the tasks you want to run.
 Any other key will be merged into the options.
 
@@ -93,9 +103,10 @@ grunt.initConfig({
 
 #### Working with existing hooks
 
-If you happen to have existing hooks in your hook folder, the plugin *appends the code launching Grunt* at the end of your hooks.
-You can also insert marker comments in your hooks to specify exactly where you want them inserted.
-Your existing hook would look something like this:
+If you happen to have existing hooks in your hook folder, the plugin *appends
+the code launching Grunt* at the end of your hooks. You can also insert marker
+comments in your hooks to specify exactly where you want them inserted. Your
+existing hook would look something like this:
 
 ```js
 // Some code run before Grunt starts
@@ -105,14 +116,16 @@ Your existing hook would look something like this:
 // Some code run after Grunt starts
 ```
 
-The markers get automatically inserted when the plugin appends code, so hooks get updated cleanly the next time you run `grunt githooks`.
+The markers get automatically inserted when the plugin appends code, so hooks
+get updated cleanly the next time you run `grunt githooks`.
 
 #### Customising hook output
 
-By default, the plugin generate NodeJS scripts for the hooks.
-Reasonning behind this is that creating Shell scripts won't work well for people using Windows.
-Plus, NodeJS is already installed as Grunt kinda needs it.
-However, you're not tied to it and you can customise the generated script entirely. In case of a Shell script:
+By default, the plugin generate NodeJS scripts for the hooks. Reasoning behind
+this is that creating Shell scripts won't work well for people using Windows.
+Plus, NodeJS is already installed as Grunt kinda needs it. However, you're not
+tied to it and you can customise the generated script entirely. In case of
+a Shell script:
 
 ```js
 grunt.initConfig({
@@ -144,9 +157,11 @@ In the template, you've got access to the following variables:
 
 #### Extending the plugin
 
-Pretty annoying when you're using a library that's missing the exact extension point you need to tweak its functionalities?
-`grunt-githooks` is based on a lot of small functions and most of them are exposed so you can override them.
-If you need feel, free to tinker with the internals (at your own risk though ;)). Could be something along:
+Pretty annoying when you're using a library that's missing the exact extension
+point you need to tweak its functionalities? `grunt-githooks` is based on a lot
+of small functions and most of them are exposed so you can override them. If you
+need feel, free to tinker with the internals (at your own risk though ;)).
+Could be something along:
 
 ```js
 var gruntGithooks = require('grunt-githooks/tasks/githooks');
@@ -190,8 +205,9 @@ code in it (to avoid inserting Node code in a Python hook for example).
 Type: `String`
 
 Path to the Handlebars template used to generate the code that will run Grunt
-in the hook. Default template is the `node.js.hb` file located in the `templates` folder of the plugin.
-It also contains a `shell.hb` file with the template for a shell script hook.
+in the hook. Default template is the `node.js.hb` file located in the `templates`
+folder of the plugin. It also contains a `shell.hb` file with the template for a
+shell script hook.
 
 > **Note**: Handlebars escapes HTML special characters if you use only two curly braces to insert
 > a variable in your template. Make sure you use three `{{{my_var}}}` if you need to insert variable
@@ -205,16 +221,18 @@ Default: `'// GRUNT-GITHOOKS START'`
 Type: `String`
 Default: `'// GRUNT-GITHOOKS END'`
 
-`startMarker` and `endMarker` are markers the plugin use to know where to insert code if a hook already exist.
-If the existing hook doesn't have these markers, the code will simply be appended.
+`startMarker` and `endMarker` are markers the plugin use to know where to insert
+code if a hook already exist. If the existing hook doesn't have these markers,
+the code will simply be appended.
 
 #### preventExit
 Type: `Boolean`
 Default `false`
 
-By default, the inserted code will exit the process after Grunt has run, using a -1 exit code if the task(s) failed.
-If you're inserting the code running Grunt in the middle of an existing hook,
-you might want to disable this so any code after what was inserted by the plugin runs.
+By default, the inserted code will exit the process after Grunt has run, using
+a -1 exit code if the task(s) failed. If you're inserting the code running Grunt
+in the middle of an existing hook, you might want to disable this so any code
+after what was inserted by the plugin runs.
 
 #### dest
 Type: `String`
@@ -226,8 +244,27 @@ Comes in handy if your Gruntfile is not at the root of your Git project.
 
 ## Contributing
 
-In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using [Grunt](http://gruntjs.com/).
+In lieu of a formal style-guide, take care to maintain the existing coding style.
+Please file a Pull Request along your issues.
 
+ * Add unit tests for any new or changed functionality.
+ * Lint and test your code using [Grunt](http://gruntjs.com/).
+ * Keep the line length at 80-100 characters per line.
+
+### File a Pull Request
+
+The process actually is quite simple:
+
+ 1. Please check out your changes on a separate branch named `issue-{$integer}` and commit against that one.
+ 1. When your tests pass and are green, merge to `dev` using `--no-ff` so we have a separate commit for that merge.
+ 1. After the review on `dev`, we can merge to `master`, again using `--no-ff`.
+ 1. The merge to `master` will get tagged. We use the [SemVer standard](http://semver.org), so _no_ leading `v`.
+
+If your PR is successful, you will get added as contributor to the repo. We
+trust you after your first PR made it into the repo and you then have access
+for further changes, handling issues, etc. So the *important* thing is to add
+your name to the `package.json` array of `contributors` when changing or adding
+some code for a PR. Please do that in a separate commit.
 
 ## Release History