chore: add husky and commitlint for improved commit message linting (#66)

* chore: add husky and commitlint for improved commit message linting

* fix: add permissions to workflow to resolve code scanning alert

Co-authored-by: Copilot Autofix powered by AI <62310815+github-advanced-security[bot]@users.noreply.github.com>

* chore: update actions/checkout and actions/setup-node versions

* chore: update husky hooks for commit and pre-push linting

* chore: update commit message guidelines for clarity

* chore: relax commitlint line length rules

---------

Co-authored-by: Copilot Autofix powered by AI <62310815+github-advanced-security[bot]@users.noreply.github.com>

Author: Morgy93

.github/CONTRIBUTING.md

@@ -79,16 +79,17 @@ src/
 
 ### Commits
 
-We follow conventional commits:
+We follow [Conventional Commits](https://www.conventionalcommits.org/) to automate our release process. We use `husky` and `commitlint` to enforce this standard locally.
 
-- `feat:` New features
-- `fix:` Bug fixes
-- `docs:` Documentation changes
-- `test:` Test additions/changes
-- `refactor:` Code refactoring
-- `chore:` Maintenance tasks
+Release Please assumes you are using Conventional Commit messages.
 
-Example: `feat: add auto-detection of PHPStan config files`
+The most important prefixes you should have in mind are:
+
+- `fix`: which represents bug fixes, and correlates to a SemVer patch.
+- `feat`: which represents a new feature, and correlates to a SemVer minor.
+- `feat!`: or `fix!:`, `refactor!:`, etc., which represent a breaking change (indicated by the `!`) and will result in a SemVer major.
+
+For a full list of types and rules, please visit [conventionalcommits.org](https://www.conventionalcommits.org/).
 
 ## Pull Request Process
 

.github/copilot-instructions.md

@@ -56,6 +56,14 @@ This project is a VS Code extension that integrates PHPStan (Static Analysis) ru
     - Use Status Bar items effectively to show tool status (Ready, Error, etc.).
     - Provide "Quick Fixes" or buttons in error messages for common actions (like "Start DDEV").
 
+5.  **Commit Messages**:
+    - STRICTLY follow [Conventional Commits](https://www.conventionalcommits.org/) format: `type(scope): description`.
+    - Release Please assumes you are using Conventional Commit messages.
+    - Most important prefixes:
+      - `fix`: bug fixes (SemVer patch).
+      - `feat`: new features (SemVer minor).
+      - `feat!`, `fix!`, `refactor!`: breaking changes (SemVer major).
+
 ## Common Tasks
 
 - **Adding a new setting**:

.github/workflows/commitlint.yml

@@ -0,0 +1,24 @@
+name: Commit Lint
+
+on: [push, pull_request]
+
+jobs:
+  commitlint:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+    steps:
+      - uses: actions/checkout@v5
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-node@v5
+        with:
+          node-version: latest
+      - name: Install dependencies
+        run: npm ci
+      - name: Validate current commit (last commit)
+        if: github.event_name == 'push'
+        run: npx commitlint --from HEAD~1 --to HEAD --verbose
+      - name: Validate PR commits
+        if: github.event_name == 'pull_request'
+        run: npx commitlint --from ${{ github.event.pull_request.base.sha }} --to ${{ github.event.pull_request.head.sha }} --verbose

.husky/commit-msg

@@ -0,0 +1,2 @@
+#!/usr/bin/env sh
+npx --no -- commitlint --edit $1

.husky/pre-commit

@@ -0,0 +1,2 @@
+#!/usr/bin/env sh
+npm run lint

.husky/pre-push

@@ -0,0 +1,2 @@
+#!/usr/bin/env sh
+npm test

commitlint.config.js

@@ -0,0 +1,8 @@
+module.exports = {
+  extends: ['@commitlint/config-conventional'],
+  rules: {
+    'body-max-line-length': [2, 'always', 300],
+    'footer-max-line-length': [2, 'always', 300],
+  },
+};
+