@citizenplane/pimp 9.2.0 → 9.3.0

package/README.md

@@ -154,19 +154,57 @@ Run the tests!
 npm run test
 ```
 
-Then install husky and gitmoji to write your best commit message:
+### 📝 Commit Guidelines
+
+This project follows [Conventional Commits](https://www.conventionalcommits.org/) specification. All commit messages are automatically validated.
+
+#### Using Interactive Commit Tool
+
+For an interactive commit experience that guides you through creating a proper commit message:
 
 ```bash
-npm i -g husky gitmoji-cli
+git add .
+npm run commit or git cz
 ```
 
-Add you changes and commit with
+#### Manual Commit Format
+
+If you prefer to write commit messages manually, follow this format:
+
+```
+<type>: <description>
+```
+
+**Available types:**
+
+- `feat`: A new feature
+- `fix`: A bug fix
+- `docs`: Documentation changes
+- `style`: Code style changes (formatting, etc.)
+- `refactor`: Code refactoring
+- `perf`: Performance improvements
+- `test`: Adding or updating tests
+- `chore`: Maintenance tasks
+- `ci`: CI/CD changes
+- `build`: Build system changes
+- `revert`: Revert a previous commit
+
+**Rules:**
+
+- Keep the description under 48 characters
+- Use lowercase for the description
+- Don't end with a period
+
+**Examples:**
 
 ```bash
-git add .
-git commit
+git commit -m "feat: add new button component"
+git commit -m "fix: resolve input validation issue"
+git commit -m "docs: update installation guide"
 ```
 
+The commit message will be automatically validated before the commit is accepted.
+
 ### 🏆 Step 6. Making your pull request
 
 To be done

package/commitlint.config.js

@@ -0,0 +1,27 @@
+export default {
+  extends: ['@commitlint/config-conventional'],
+  rules: {
+    // Limit subject length to 84 characters as requested
+    'subject-max-length': [1, 'always', 84],
+    // Ensure subject is in lowercase
+    'subject-case': [0, 'always', 'lower-case'],
+    // Allowed types according to conventional commits
+    'type-enum': [
+      2,
+      'always',
+      [
+        'feat', // new feature
+        'fix', // bug fix
+        'docs', // documentation
+        'style', // formatting, missing semicolons, etc.
+        'refactor', // code refactoring
+        'perf', // performance improvements
+        'test', // adding tests
+        'chore', // maintenance tasks
+        'ci', // continuous integration
+        'build', // build system
+        'revert', // revert commit
+      ],
+    ],
+  },
+}