root: ci: Add husky,commitlint.config.js& Update docs

Author: dibyanshu-pal-kushwaha

.github/workflows/lint-commit.yml

@@ -0,0 +1,21 @@
+name: Lint Commit Messages
+
+on: [pull_request]
+
+jobs:
+  lint-commit:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+          cache: "npm"
+          cache-dependency-path: package-lock.json
+      - name: Install dependencies
+        run: npm ci
+      - name: Lint commit messages
+        run: npm run lint:commit

.husky/commit-msg

@@ -0,0 +1 @@
+npx --no -- commitlint --edit "$1"

.husky/pre-commit

@@ -0,0 +1 @@
+cd frontend && npx lint-staged

commitlint.config.js

@@ -0,0 +1,54 @@
+module.exports = {
+  plugins: [
+    {
+      rules: {
+        'headlamp-format': ({ header }) => {
+          if (!header) {
+            return [false, 'Commit message header must not be empty'];
+          }
+          if (/ :/.test(header)) {
+            return [false, 'There should be no space before ":"'];
+          }
+          const parts = header.split(':').map(p => p.trim());
+          if (parts.length < 2) {
+            return [
+              false,
+              'Commit message must follow format: <area>: <description>',
+            ];
+          }
+          const [area, subOrDesc] = parts;
+          if (!area) {
+            return [false, 'Area must not be empty'];
+          }
+          if (!subOrDesc) {
+            return [false, 'Description or sub-area must not be empty'];
+          }
+          const strictAreas = ['app', 'frontend', 'backend'];
+          if (strictAreas.includes(area.toLowerCase()) && parts.length < 3) {
+            return [
+              false,
+              `Commits starting with "${area}" must follow format: ` +
+              `<${area}>: <sub-area>: <description>\n` +
+              `Example: "${area}: HomeButton: Fix navigation"`,
+            ];
+          }
+          const description =
+            parts.length >= 3 ? parts.slice(2).join(': ') : parts[1];
+          if (!description) {
+            return [false, 'Description must not be empty'];
+          }
+          if (description[0] !== description[0].toUpperCase()) {
+            return [false, 'Description must start with a capitalized verb'];
+          }
+          return [true, ''];
+        },
+      },
+    },
+  ],
+
+  rules: {
+    'headlamp-format': [2, 'always'],
+    'header-max-length': [2, 'always', 72],
+    'body-max-line-length': [2, 'always', 72],
+  },
+};

docs/contributing.md

@@ -185,6 +185,13 @@ dedicated [i18n docs](./development/i18n).
 For general guidelines on making PRs/commits easier to review, please check
 out Kinvolk's
 [contribution guidelines on git](https://github.com/kinvolk/contribution/tree/master/topics/git.md).
+We also use `commitlint` to enforce these guidelines automatically. You can check your commits locally by running:
+
+```bash
+npm run lint:commit
+```
+
+This command checks all commit messages that exist after origin/main against our guidelines. The same check runs in our CI system for every Pull Request.
 
 ## Testing
 

frontend/package.json

@@ -135,11 +135,6 @@
       "last 1 safari version"
     ]
   },
-  "husky": {
-    "hooks": {
-      "pre-commit": "lint-staged"
-    }
-  },
   "lint-staged": {
     "src/**/*.{js,jsx,ts,tsx}": [
       "eslint -c package.json --fix"
@@ -218,7 +213,6 @@
     "@vitest/coverage-istanbul": "^3.0.5",
     "eslint-plugin-license-header": "^0.8.0",
     "fast-check": "^4.5.3",
-    "husky": "^4.3.8",
     "i18next-parser": "^9.1.0",
     "jsdom": "^24.0.0",
     "lint-staged": "^10.5.4",