chore: add commit message templates and rules for consistency (#1523)

github-actions[bot] · Marfuen · web-flow · commit 6a6a4e402510 · 2025-09-16T15:51:55.000-04:00
Co-authored-by: Mariano Fuentes &lt;marfuen98@gmail.com&gt;
diff --git a/.cursorrules b/.cursorrules
@@ -0,0 +1,40 @@
+# Commit Message Rules
+
+When generating commit messages, ALWAYS follow the Conventional Commits specification:
+
+## Format
+
+`<type>(<scope>): <description>`
+
+## Types (use exactly these):
+
+- feat: A new feature
+- fix: A bug fix
+- docs: Documentation only changes
+- style: Changes that do not affect the meaning of the code (formatting, missing semi-colons, etc)
+- refactor: A code change that neither fixes a bug nor adds a feature
+- perf: A code change that improves performance
+- test: Adding missing tests or correcting existing tests
+- build: Changes that affect the build system or external dependencies
+- ci: Changes to CI configuration files and scripts
+- chore: Other changes that don't modify src or test files
+- revert: Reverts a previous commit
+
+## Rules:
+
+1. Use lowercase for type
+2. Scope is optional but recommended (e.g., auth, api, ui, db)
+3. Description must be in imperative mood ("add" not "added" or "adds")
+4. Description must start with lowercase
+5. No period at the end of the description
+6. Keep the first line under 72 characters
+
+## Examples:
+
+- ✅ feat(auth): add social login with Google OAuth
+- ✅ fix(api): resolve race condition in user update endpoint
+- ✅ chore: update dependencies to latest versions
+- ✅ docs(readme): add installation instructions for Windows
+- ❌ Added new feature (missing type)
+- ❌ feat: Added login (wrong tense, capitalized)
+- ❌ fix(api): fixes bug. (wrong tense, has period)
diff --git a/.gitmessage b/.gitmessage
@@ -0,0 +1,42 @@
+# <type>(<scope>): <subject>
+#
+# <body>
+#
+# <footer>
+#
+# Type must be one of the following:
+# * feat: A new feature
+# * fix: A bug fix
+# * docs: Documentation only changes
+# * style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
+# * refactor: A code change that neither fixes a bug nor adds a feature
+# * perf: A code change that improves performance
+# * test: Adding missing tests or correcting existing tests
+# * build: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
+# * ci: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
+# * chore: Other changes that don't modify src or test files
+# * revert: Reverts a previous commit
+#
+# Scope is optional and can be anything specifying the place of the commit change.
+# For example: auth, api, ui, db, etc.
+#
+# Subject must:
+# * use the imperative, present tense: "change" not "changed" nor "changes"
+# * don't capitalize the first letter
+# * no dot (.) at the end
+#
+# Body should include the motivation for the change and contrast this with previous behavior.
+#
+# Footer should contain any information about Breaking Changes and is also the place to
+# reference GitHub issues that this commit closes.
+#
+# Breaking Changes should start with the word BREAKING CHANGE: with a space or two newlines.
+# The rest of the commit message is then used for this.
+#
+# Example:
+# feat(auth): add OAuth2 integration
+#
+# Add support for OAuth2 authentication with Google and GitHub providers.
+# This allows users to sign in using their existing accounts.
+#
+# Closes #123
diff --git a/.husky/commit-msg b/.husky/commit-msg
@@ -0,0 +1,4 @@
+#!/usr/bin/env sh
+. "$(dirname "$0")/_/husky.sh"
+
+npx commitlint --edit $1
