Merge pull request #57 from aj3sh/commitlint

Added commit message check on pre-commit hook
opensource-nepal · Sep 13, 2023 · d0361f0 · d0361f0
2 parents 86b68ca + 511bee2
commit d0361f0
Show file tree

Hide file tree

Showing 5 changed files with 1,453 additions and 23 deletions.
diff --git a/.commitlintrc.json b/.commitlintrc.json
@@ -0,0 +1,3 @@
+{
+    "extends": ["@commitlint/config-conventional"]
+}
diff --git a/.husky/commit-msg b/.husky/commit-msg
@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+npx --no-install commitlint --edit $1
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -26,6 +26,8 @@ Before submitting your Pull Request, please do the following steps:
 1. Add tests for the new changes.
 1. Update the `CHANGELOG.md` file if necessary.
 1. Edit documentation (`README.md`) if you have changed something significant.
+1. Commit your changes using [semantic commit message](https://seesparkbox.com/foundry/semantic_commit_messages).  
+   Examples: `"fix: Fixed foobar bug"`, `"feat(accounts): Added foobar feature on accounts"`.
 
 ## Other help