Lint commit messages to enforce consistency

.commitlintrc.yaml

@@ -0,0 +1,23 @@
+rules:
+  header-case:
+  - 2
+  - always
+  - - sentence-case
+  header-max-length:
+  - 2
+  - always
+  - 50
+  header-full-stop:
+  - 2
+  - never
+  - "."
+  body-case:
+  - 2
+  - always
+  - - sentence-case
+  body-leading-blank:
+  - 2
+  - always
+  type-empty:
+  - 2
+  - always

.github/workflows/commit.yml

@@ -0,0 +1,27 @@
+name: Lint commit messages
+
+on: 
+  pull_request:
+
+permissions:
+  contents: read
+  pull-requests: read
+
+jobs:
+  commitlint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout "main" branch
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          ref: ${{ github.event.pull_request.base.ref }}
+
+      - name: Checkout the current pull request branch
+        run: git checkout ${{ github.event.pull_request.head.ref }}
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Lint commit messages
+        run: npm run commit-messages:lint

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 All changes that impact users of this module are documented in this file, in the [Common Changelog](https://common-changelog.org) format with some additional specifications defined in the CONTRIBUTING file. This codebase adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## Unreleased [no-release]
+
+_Modifications made in this changeset do not add, remove or alter any behavior, dependency, API or functionality of the software. They only change non-functional parts of the repository, such as the README file or CI workflows._
+
 ## 0.37.1 - 2024-02-20
 
 _Full changeset and discussions: [#1056](https://github.com/OpenTermsArchive/engine/pull/1056)._

CONTRIBUTING.md

@@ -48,10 +48,13 @@ We strive to follow this [recommendation](https://chris.beams.io/posts/git-commi
 - [Capitalize the subject line](https://chris.beams.io/posts/git-commit/#capitalize).
 - [Do not end the subject line with a period](https://chris.beams.io/posts/git-commit/#end).
 - [Use the imperative mood in the subject line](https://chris.beams.io/posts/git-commit/#imperative).
-- [Wrap the body at 72 characters](https://chris.beams.io/posts/git-commit/#wrap-72).
 - [Use the body to explain what and why vs. how](https://chris.beams.io/posts/git-commit/#why-not-how).
 
-We add this additional rule:
+Except this one:
+
+- ~~[Wrap the body at 72 characters](https://chris.beams.io/posts/git-commit/#wrap-72)~~: As URLs might be used for references in commit messages, the body text is not wrapped to 72 characters to ensure links are clickable in Git user interfaces.
+
+We add these additional rules:
 
 - Do not rely on GitHub issue reference numbers in commit messages, as we have no guarantee the host system and its autolinking will be stable in time. Make sure the context is self-explanatory. If an external reference is given, use its full URL.