agentleFS
aymericzipaymericzip/intlayer/.cursor/rules/commit-message-guidelines.md

intlayer / rules

Cursor rule863 starsChanged 13 days agoApache-2.0View on GitHub

This project uses Conventional Commits and validates every commit with commitlint (see commitlint.config.ts). Exceeding these limits will cause commit validation to fail. Any other type will be rejected by commitlint. Provide context, motivation and contrast with previous behavior. Requirements: Used for metadata such as breaking changes or issue references. Requirements:

The file

We split this commit-message-guidelines.md into the rules it gives an agent

7 rules. About 0 are common, 7 are distinctive, and 0 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈7

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 0

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Use the imperative mood: "add", "fix", "remove", not "added" or "adding".

    line 47
  2. Distinctive:

    Must be lower-case (no sentence-case, start-case, pascal-case, or upper-case).

    line 48
  3. Distinctive:

    Don't capitalize the first letter beyond what's required for acronyms.

    line 49
  4. Distinctive:

    Don't end with a period.

    line 50
  5. Distinctive:

    Must have a blank line before the body content (warning level).

    line 66
  6. Distinctive:

    Must have a blank line before the footer content (warning level).

    line 83
  7. Distinctive:

    Use git commit --amend to fix a rejected message.

    line 117

≈ “Common” is an estimate: at least 1 in 5 of the 6,668 Cursor rule files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
commit-message-guidelines.md

Conventional Commit Message Guidelines

This project uses Conventional Commits and validates every commit with commitlint (see commitlint.config.ts).

1. Message Format

<type>(<scope>): <subject>

[optional body]
[optional footer]
  • <type>: one of the allowed types below (lower-case)
  • <scope> (optional): a package, app, or general scope (lower-case, no spaces)
  • <subject>: short description in the imperative mood, no trailing period

2. Length Restrictions

ComponentMax LengthRule Level
Header (entire first line)100 charactersError
Body (each line)100 charactersError
Footer (each line)100 charactersError

Exceeding these limits will cause commit validation to fail.

3. Allowed Types

TypeWhen to use it
buildChanges to build system, tooling, or external dependencies
choreRoutine tasks (e.g., lockfile update, minor refactor with no behavior change)
ciCI configuration or scripts
docDocumentation-only changes
featIntroducing new features
fixBug fixes
perfPerformance improvements
refactorCode changes that neither fix a bug nor add a feature
styleCode style changes (formatting, whitespace, etc.)
testAdding or updating tests

Any other type will be rejected by commitlint.

4. Subject Rules

  • Use the imperative mood: "add", "fix", "remove", not "added" or "adding".
  • Must be lower-case (no sentence-case, start-case, pascal-case, or upper-case).
  • Don't capitalize the first letter beyond what's required for acronyms.
  • Don't end with a period.
  • Cannot be empty (required).

5. Scope Rules

  • Optional but recommended for clarity.
  • Must be lower-case (enforced by commitlint).
  • Hyphen-separated if multi-word.
  • Examples: react-intlayer, backend, website, scripts.

6. Body (Optional)

Provide context, motivation and contrast with previous behavior.

Requirements:

  • Must have a blank line before the body content (warning level).
  • Each line must not exceed 100 characters (error level).
<type>(<scope>): <subject>
<BLANK LINE>
Detailed explanation of **what** and **why**.
Each line in the body must be 100 characters or less.
<BLANK LINE>

7. Footer (Optional)

Used for metadata such as breaking changes or issue references.

Requirements:

  • Must have a blank line before the footer content (warning level).
  • Each line must not exceed 100 characters (error level).
<type>(<scope>): <subject>

[optional body]
<BLANK LINE>
BREAKING CHANGE: describe the breaking change here

Closes #123

8. Examples

feat(core): add version comparison utility
fix(website): correct 404 layout on nested routes
chore: update lockfile
style(backend): run eslint --fix on src directory

9. Quick Checklist

  1. Correct type from the list above (lower-case)
  2. (Optional) concise scope in lower-case
  3. Subject in lower-case, imperative mood, ≤ 100 chars total header, no period
  4. Body with blank line before, each line ≤ 100 chars
  5. Footer with blank line before, each line ≤ 100 chars, for breaking changes/issue refs

10. Validation & Automation

  • The .husky/commit-msg hook runs bun exec commitlint --edit "$1".
  • Any deviation from the rules aborts the commit with guidance.
  • Use git commit --amend to fix a rejected message.

Following these guidelines keeps the project history clean, makes changelogs automatic, and helps everyone understand why a change exists.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.