chore: Adds git pre-push hook that validates commit message formatting (#516)

* chore: Adds git pre-push hook that validates commit message formatting

* chore: Adds a pre-push hook

* refactor: Fixed script name

* refactor: Make the script fancy

* chore: Add pre-commit hook too

* chore: Add helper

* refactor: execute a common script

* fix: whitespace

* fix: fix up hints

* fix: no whitespace

* chore: add a commit-msg hook

* chore: bad message

* chore: use stdin

* chore: a better stdin approach

* docs: fix up docs for windows users

* docs: bold, not italics

* chore: add --silent option

Author: kumar303

.githooks/commit-msg/check-for-changelog-lint

@@ -0,0 +1,29 @@
+#!/bin/bash
+# Because commits are hard to remove (unless you are a pro at interactive
+# rebasing), this commit hook script should make it easier for new
+# contributors.
+
+commit_msg=$1
+cat "$commit_msg" | npm run changelog-lint-from-stdin --silent
+exit_status=$?
+
+if [ $exit_status -ne 0 ]; then
+    echo
+    echo "Your unsaved commit message:"
+    echo
+    cat "$commit_msg"
+    echo
+    echo "--------------------------------------------------------------------"
+    echo "Your commit was not saved because the message was formatted incorrectly."
+    echo "See the error log above."
+    echo "--------------------------------------------------------------------"
+    echo
+    echo "For formatting instructions, see:"
+    echo "https://github.com/mozilla/web-ext/blob/master/CONTRIBUTING.md#writing-commit-messages"
+    echo
+    echo "To bypass this check and commit anyway, use:"
+    echo "git commit --no-verify ..."
+    echo
+fi
+
+exit $exit_status

CONTRIBUTING.md

@@ -141,12 +141,16 @@ Examples:
 If you want to use scopes then it would look more like:
 `feat(dysfunctioner): Added --quiet option`.
 
-### Check for commit message lint
+### Checking commit message formatting
 
-You can test that your commit message is formatted in a way that will support
-our changelog generator like this:
+Because editing git history is difficult for many developers,
+the commit message formatting described above is automatically enforced
+each time you commit to your work branch.
 
-    npm run changelog-lint
+**If you're on Windows**, the commit message verification currently doesn't
+work (sorry!). You will need to commit to your branch using this command:
+
+    git commit --no-verify
 
 ## Squashing commits
 

LICENSE

@@ -35,7 +35,7 @@ Mozilla Public License Version 2.0
     means any form of the work other than Source Code Form.
 
 1.7. "Larger Work"
-    means a work that combines Covered Software with other material, in 
+    means a work that combines Covered Software with other material, in
     a separate file or files, that is not Covered Software.
 
 1.8. "License"

package.json

@@ -20,7 +20,8 @@
     "publish-coverage": "grunt coveralls",
     "nsp-check": "nsp check -o summary",
     "changelog": "conventional-changelog -p angular -u",
-    "changelog-lint": "conventional-changelog-lint --from master"
+    "changelog-lint": "conventional-changelog-lint --from master",
+    "changelog-lint-from-stdin": "conventional-changelog-lint"
   },
   "homepage": "https://github.com/mozilla/web-ext",
   "repository": {
@@ -85,6 +86,7 @@
     "eslint-plugin-flowtype": "2.19.0",
     "firefox-client": "0.3.0",
     "flow-bin": "0.33.0",
+    "git-hooks": "1.1.1",
     "grunt": "1.0.1",
     "grunt-contrib-clean": "1.0.0",
     "grunt-contrib-copy": "1.0.0",