chore: add a CONTRIBUTING guide and commitizen to enforce commit messages formats

feat/contributing

Author: Merott

CONTRIBUTING.md

@@ -0,0 +1,13 @@
+# Contributing
+
+First of all, thank you!
+
+## Commit Messages
+
+This project uses [`semantic-release`](https://github.com/semantic-release/semantic-release) to manage its releases, and therefore your commit messages must follow a [strict commit message format](https://github.com/semantic-release/semantic-release#default-commit-message-format).
+
+You may choose to use `npm run commit` instead of `git commit`, and you'll be presented with an interactive session that will generate your commit message for you.
+
+## Linting TypeScript Code
+
+Make sure that your code changes pass the project TSLint rules. You can find out by running `npm run lint`. The task also runs on the Continuous Integration environment and will fail the build if it does not pass.

package.json

@@ -12,6 +12,8 @@
   },
   "scripts": {
     "build": "tsc",
+    "commit": "git-cz",
+    "commitmsg": "cz-customizable-ghooks",
     "demo.ios": "npm run preparedemo && cd demo && tns run ios --emulator",
     "demo.ios.device": "npm run preparedemo && cd demo && tns run ios",
     "demo.android": "npm run preparedemo && cd demo && tns run android --emulator",
@@ -55,6 +57,10 @@
   "devDependencies": {
     "@semantic-release/condition-codeship": "^1.1.0",
     "@semantic-release/release-notes-generator": "^2.0.0",
+    "commitizen": "^2.9.6",
+    "cz-customizable": "^5.0.0",
+    "cz-customizable-ghooks": "^1.5.0",
+    "husky": "^0.13.3",
     "prompt": "~1.0.0",
     "rimraf": "~2.6.1",
     "semantic-release": "^6.3.6",
@@ -63,5 +69,13 @@
     "tslint": "^5.2.0",
     "tslint-stylish": "^2.1.0",
     "typescript": "~2.3.2"
+  },
+  "config": {
+    "commitizen": {
+      "path": "./node_modules/cz-customizable"
+    },
+    "cz-customizable": {
+      "config": ".cz-config.js"
+    }
   }
 }