From 6a6a4e4025109af9166d978b8c960dad6f7063fa Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Tue, 16 Sep 2025 15:51:55 -0400 Subject: [PATCH] chore: add commit message templates and rules for consistency (#1523) Co-authored-by: Mariano Fuentes --- .cursorrules | 40 ++++++++++++++++++++++++++++++++++++++++ .gitmessage | 42 ++++++++++++++++++++++++++++++++++++++++++ .husky/commit-msg | 4 ++++ 3 files changed, 86 insertions(+) create mode 100644 .cursorrules create mode 100644 .gitmessage create mode 100755 .husky/commit-msg diff --git a/.cursorrules b/.cursorrules new file mode 100644 index 000000000..bc3e95bd5 --- /dev/null +++ b/.cursorrules @@ -0,0 +1,40 @@ +# Commit Message Rules + +When generating commit messages, ALWAYS follow the Conventional Commits specification: + +## Format + +`(): ` + +## 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 new file mode 100644 index 000000000..4b84e32f6 --- /dev/null +++ b/.gitmessage @@ -0,0 +1,42 @@ +# (): +# +# +# +#