feat(git-hooks): add commit message validation and pre-commit checks

.git-hooks/commit-msg

@@ -0,0 +1,4 @@
+#!/bin/sh
+set -e
+
+npx --yes @commitlint/cli@20.4.3 --edit "$1"

.github/workflows/commit-check.yml

@@ -0,0 +1,29 @@
+name: Commit Message Check
+
+on:
+  pull_request:
+    types: [opened, synchronize, reopened]
+
+jobs:
+  commit-check:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+
+      - name: Validate commit messages
+        run: |
+          set -eo pipefail
+          commits=$(git log --no-merges --pretty=format:"%H" "${{ github.event.pull_request.base.sha }}..${{ github.event.pull_request.head.sha }}")
+          for sha in $commits; do
+            tmp=$(mktemp)
+            git log -1 --pretty=format:"%B" "$sha" > "$tmp"
+            npx --yes @commitlint/cli@20.4.3 --edit "$tmp"
+            rm "$tmp"
+          done

README.md

@@ -20,13 +20,15 @@ Find the detailed list of software dependencies [here] (https://piramal-swasthya
 Please follow these steps:
 
 1. Clone the repository to your local machine.
-2. Install the dependencies and build the module:
+2. Enable git hooks (run once after cloning):
+   - Run the command `git config core.hooksPath .git-hooks`.
+3. Install the dependencies and build the module:
     - Run the command `mvn clean install`.
-3. You can copy `bengen_example.properties` to `bengen_local.properties` and edit the file accordingly. The file is under `src/main/environment` folder.
-4. Run the development server:
+4. You can copy `bengen_example.properties` to `bengen_local.properties` and edit the file accordingly. The file is under `src/main/environment` folder.
+5. Run the development server:
     - Start the Redis server.
     - Run the command `mvn spring-boot:run -DENV_VAR=local`.
-5. Open your browser and access `http://localhost:8080/swagger-ui.html#!/` to view the Swagger API documentation.
+6. Open your browser and access `http://localhost:8080/swagger-ui.html#!/` to view the Swagger API documentation.
 
 
 ## Usage

commitlint.config.js

@@ -0,0 +1,35 @@
+module.exports = {
+  rules: {
+    'body-leading-blank': [1, 'always'],
+    'body-max-line-length': [2, 'always', 100],
+    'footer-leading-blank': [1, 'always'],
+    'footer-max-line-length': [2, 'always', 100],
+    'header-max-length': [2, 'always', 100],
+    'subject-case': [
+      2,
+      'never',
+      ['sentence-case', 'start-case', 'pascal-case', 'upper-case'],
+    ],
+    'subject-empty': [2, 'never'],
+    'subject-full-stop': [2, 'never', '.'],
+    'type-case': [2, 'always', 'lower-case'],
+    'type-empty': [2, 'never'],
+    'type-enum': [
+      2,
+      'always',
+      [
+        'build',
+        'chore',
+        'ci',
+        'docs',
+        'feat',
+        'fix',
+        'perf',
+        'refactor',
+        'revert',
+        'style',
+        'test',
+      ],
+    ],
+  },
+};