Merge pull request #8 from chalettu/commitizen

Added Commitizen to repo.
ManageIQ · Apr 20, 2017 · 90f51e5 · 90f51e5
2 parents 836bb81 + d2979a5
commit 90f51e5
Show file tree

Hide file tree

Showing 4 changed files with 93 additions and 1 deletion.
diff --git a/.gitignore b/.gitignore
@@ -60,3 +60,5 @@ typings/
 #local db and local json files
 db.json
 local/*.json
+
+.DS_Store*
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,77 @@
+# Contributing to Mock API
+
+ - [Commit Message Guidelines](#commit)
+
+
+## <a name="commit"></a> Git Commit Guidelines
+
+We have very precise rules over how our git commit messages can be formatted.  This leads to **more
+readable messages** that are easy to follow when looking through the **project history**.  But also,
+we use the git commit messages to **generate the AngularJS change log**.
+
+The commit message formatting can be added using a typical git workflow or through the use of a CLI
+wizard ([Commitizen](https://github.com/commitizen/cz-cli)). To use the wizard, run `yarn run commit`
+in your terminal after staging your changes in git.
+
+### Commit Message Format
+Each commit message consists of a **header**, a **body** and a **footer**.  The header has a special
+format that includes a **type**, a **scope** and a **subject**:
+
+```
+<type>(<scope>): <subject>
+<BLANK LINE>
+<body>
+<BLANK LINE>
+<footer>
+```
+
+The **header** is mandatory and the **scope** of the header is optional.
+
+Any line of the commit message cannot be longer 100 characters! This allows the message to be easier
+to read on GitHub as well as in various git tools.
+
+### Revert
+If the commit reverts a previous commit, it should begin with `revert: `, followed by the header of the reverted commit.
+In the body it should say: `This reverts commit <hash>.`, where the hash is the SHA of the commit being reverted.
+
+### Type
+Must be one of the following:
+
+* **feat**: A new feature
+* **fix**: A bug fix
+* **docs**: Documentation only changes
+* **style**: Changes that do not affect the meaning of the code (white-space, formatting, missing
+  semi-colons, etc)
+* **refactor**: A code change that neither fixes a bug nor adds a feature
+* **perf**: A code change that improves performance
+* **test**: Adding missing or correcting existing tests
+* **chore**: Changes to the build process or auxiliary tools and libraries such as documentation
+  generation
+
+### Scope
+The scope could be anything specifying place of the commit change. For example `$location`,
+`$browser`, `$compile`, `$rootScope`, `ngHref`, `ngClick`, `ngView`, etc...
+
+You can use `*` when the change affects more than a single scope.
+
+### Subject
+The subject contains succinct description of the change:
+
+* use the imperative, present tense: "change" not "changed" nor "changes"
+* don't capitalize first letter
+* no dot (.) at the end
+
+### Body
+Just as in the **subject**, use the imperative, present tense: "change" not "changed" nor "changes".
+The body should include the motivation for the change and contrast this with previous behavior.
+
+### Footer
+The footer should contain any information about **Breaking Changes** and is also the place to
+[reference GitHub issues that this commit closes][closing-issues].
+
+**Breaking Changes** should start with the word `BREAKING CHANGE:` with a space or two newlines.
+The rest of the commit message is then used for this.
+
+A detailed explanation can be found in this [document][commit-message-format].
+
+[commit-message-format]: https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit#
diff --git a/README.md b/README.md
@@ -1,7 +1,9 @@
 # ManageIQ Mock API
 
 [![Build Status](https://travis-ci.org/ManageIQ/manageiq-api-mock.svg?branch=master)](https://travis-ci.org/ManageIQ/manageiq-api-mock)
-[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg?style=plastic)](https://github.com/semantic-release/semantic-release)
+[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)
+[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)  
+
 ## Installation
 
 If you don't plan on doing doing development for Mock API and would just like to use what has been developed, please run 
@@ -89,3 +91,6 @@ or subpaths
 ```
 #### Overriding stock endpoints with local changes
 If you would like to override any of the endpoints in the repo please drop the overriden files into the **/local** directory structure.  This will pick up and override files that match from stock data.  
+
+### Contributing
+Please see [CONTRIBUTING.md](CONTRIBUTING.md) for more details on how to contribute to this repo. 
diff --git a/package.json b/package.json
@@ -7,6 +7,7 @@
   "repository": "https://github.com/ManageIQ/manageiq-api-mock.git",
   "license": "Apache-2.0",
   "scripts": {
+    "commit": "git-cz",
     "start": "node index.js",
     "semantic-release": "semantic-release pre && npm publish && semantic-release post"
   },
@@ -23,6 +24,13 @@
     "mockapi": "index.js"
   },
   "devDependencies": {
+    "commitizen": "^2.9.6",
+    "cz-conventional-changelog": "^2.0.0",
     "semantic-release": "^6.3.2"
+  },
+  "config": {
+    "commitizen": {
+      "path": "./node_modules/cz-conventional-changelog"
+    }
   }
 }