feat(ci) : implement commit message standards and automation

.commitlintrc.json

@@ -0,0 +1,36 @@
+{
+  "extends": ["@commitlint/config-conventional"],
+  "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"
+      ]
+    ]
+  }
+}

.github/commitlint.config.js

@@ -0,0 +1,3 @@
+module.exports = {
+  extends: ["@commitlint/config-conventional"]
+};

.github/workflows/commitlint.yml

@@ -0,0 +1,21 @@
+name: Lint Commit Messages
+
+on:
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  commitlint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-node@v3
+        with:
+          node-version: '18'
+      - name: Install dependencies
+        run: npm ci
+      - name: Check commit messages
+        run: |
+          npx commitlint --config .commitlintrc.json --from="${{ github.event.pull_request.base.sha }}" --to="${{ github.sha }}"

.gitignore

@@ -2,6 +2,21 @@ target/
 !.mvn/wrapper/maven-wrapper.jar
 command_output.log
 
+### Java ###
+hs_err_pid*.log
+replay_pid*.log
+
+### Node.js ###
+node_modules/
+npm-debug.log
+yarn-debug.log*
+yarn-error.log*
+.env
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
 ### STS ###
 .apt_generated
 .classpath

.husky/commit-msg

@@ -0,0 +1,2 @@
+#!/bin/sh
+npm run commitmsg -- "$1"

.husky/pre-commit

@@ -0,0 +1,5 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+# Run tests if they exist
+npm run test:ci

.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+    "java.compile.nullAnalysis.mode": "automatic"
+}

README.md

@@ -3,6 +3,31 @@
 
 This service is used to generate unique beneficiary registration Id for new beneficiaries.
 
+## Commit Message Standards
+This project follows the [Conventional Commits](https://www.conventionalcommits.org/) specification. Commit messages must follow this format:
+
+```
+<type>(<scope>): <description>
+
+[optional body]
+
+[optional footer(s)]
+```
+
+### Types
+- `feat`: A new feature
+- `fix`: A bug fix
+- `docs`: Documentation only changes
+- `style`: Changes that do not affect the meaning of the code
+- `refactor`: A code change that neither fixes a bug nor adds a feature
+- `perf`: A code change that improves performance
+- `test`: Adding missing tests or correcting existing tests
+
+### Tools
+- Commitlint: Enforces commit message format
+- Husky: Git hooks for pre-commit checks
+- Commitizen: Interactive commit message creation
+
 ## Building From Source
 This microservice is built on Java, Spring boot framework and MySQL DB.
 
@@ -37,5 +62,5 @@ If you encounter any issues, bugs, or have feature requests, please file them in
 
 ## Join Our Community
 
-We’d love to have you join our community discussions and get real-time support!  
+We'd love to have you join our community discussions and get real-time support!  
 Join our [Discord server](https://discord.gg/FVQWsf5ENS) to connect with contributors, ask questions, and stay updated.