feat(commitlint): add commitlint linter to follow conventional commit…

… specifications add commitlint linter setup precommit hooks using husky update readme signed-off-by: Pavan Joshi <[email protected]>
getAlby · Feb 28, 2022 · f349202 · f349202
1 parent a2c3ab9
commit f349202
Show file tree

Hide file tree

Showing 5 changed files with 438 additions and 34 deletions.
diff --git a/.husky/commit-msg b/.husky/commit-msg
@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+yarn commitlint --edit 
diff --git a/README.md b/README.md
@@ -159,6 +159,8 @@ We use the [Development Project Board](https://github.com/getAlby/lightning-brow
 
 If you're a developer looking to help but not sure where to begin, check out the issues that have specifically been marked as being friendly to new contributors [here](https://github.com/getAlby/lightning-browser-extension/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22+project%3AgetAlby%2Flightning-browser-extension%2F2).
 
+> Alby enforces [Conventional Commits specification](https://www.conventionalcommits.org/en/v1.0.0/) for adding human and machine readable meaning to commit messages, make sure to read and follow them.
+
 If you're looking for a bigger challenge, before opening a pull request please [create an issue](https://github.com/bumi/lightning-browser-extension/issues/new) or [join our community chat](https://bitcoindesign.slack.com/archives/C02591ADXM2) to get feedback, discuss the best way to tackle the challenge, and to ensure that there's no duplication of work.
 
 ## ❔ FAQs

diff --git a/commitlint.config.js b/commitlint.config.js
@@ -0,0 +1,5 @@
+module.exports = {
+    extends: [
+        "@commitlint/config-conventional"
+    ],
+}
diff --git a/package.json b/package.json
@@ -84,6 +84,8 @@
     "@babel/preset-env": "^7.16.11",
     "@babel/preset-react": "^7.16.7",
     "@babel/preset-typescript": "^7.16.7",
+    "@commitlint/cli": "^16.2.1",
+    "@commitlint/config-conventional": "^16.2.1",
     "@storybook/addon-actions": "^6.4.18",
     "@storybook/addon-essentials": "^6.4.18",
     "@storybook/addon-links": "^6.4.18",