feat(commit-config): Implemented Commit Message Linting and Automation for TM-API #85

.github/workflows/commitlint.yml

@@ -0,0 +1,31 @@
+name: Commit Compliance
+
+on:
+  pull_request:
+    types: [opened, synchronize, reopened]
+
+jobs:
+  commitlint:
+    name: Lint commit messages
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code with submodules
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ github.event.pull_request.head.ref }}
+          repository: ${{ github.event.pull_request.head.repo.full_name }}
+          submodules: true
+          fetch-depth: 0
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 18
+
+      - name: Install dependencies
+        run: npm ci --legacy-peer-deps
+
+      - name: Run commitlint on PR
+        run: |
+          npx commitlint --from ${{ github.event.pull_request.base.sha }} --to ${{ github.event.pull_request.head.sha }} --verbose

.husky/commit-msg

@@ -0,0 +1,3 @@
+#!/bin/sh
+
+npx --no -- commitlint --edit "$1"

README.md

@@ -55,6 +55,46 @@ To build the TM module from source, follow these steps:
   ```
 - Open your browser and navigate to http://localhost:8080/swagger-ui.html#!/
 
+## Setting Up Commit Hooks
+This project uses Git hooks to enforce consistent code quality and commit message standards. Even though this is a Java project, the hooks are powered by Node.js. Follow these steps to set up the hooks locally:
+### Prerequisites
+- Node.js (v14 or later)
+- npm (comes with Node.js)
+### Setup Steps
+1. **Install Node.js and npm**
+   - Download and install from [nodejs.org](https://nodejs.org/)
+   - Verify installation with:
+     ```
+     node --version
+     npm --version
+     ```
+2. **Install dependencies**
+   - From the project root directory, run:
+     ```
+     npm ci
+     ```
+   - This will install all required dependencies including Husky and commitlint
+3. **Verify hooks installation**
+   - The hooks should be automatically installed by Husky
+   - You can verify by checking if the `.husky` directory contains executable hooks
+### Commit Message Convention
+This project follows a specific commit message format:
+- Format: `type(scope): subject`
+- Example: `feat(login): add remember me functionality`
+
+Types include:
+- `feat`: A new feature
+- `fix`: A bug fix
+- `docs`: Documentation changes
+- `style`: Code style changes (formatting, etc.)
+- `refactor`: Code changes that neither fix bugs nor add features
+- `perf`: Performance improvements
+- `test`: Adding or fixing tests
+- `build`: Changes to build process or tools
+- `ci`: Changes to CI configuration
+- `chore`: Other changes (e.g., maintenance tasks, dependencies)
+
+Your commit messages will be automatically validated when you commit, ensuring project consistency.
 ## Usage
 
 All the features of the TM module have been exposed as REST endpoints. For detailed information on how to use the service, refer to the SWAGGER API specification.

commitlint.config.js

@@ -0,0 +1,36 @@
+module.exports = {
+    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",
+        ],
+      ],
+    },
+  };