Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature Enhancement Request: Support Customizable Git Commit Formats #2557

Open
1Ckpwee opened this issue Jan 8, 2025 · 0 comments
Open

Comments

@1Ckpwee
Copy link

1Ckpwee commented Jan 8, 2025

Background

Cursor currently supports generating git commit messages based on code changes. While this is a helpful feature, the automatically generated commit messages often do not align with specific commit conventions or formats used in different projects or organizations.

Feature Request

Provide a configuration option that allows users to define their preferred git commit format. This feature would enable teams to enforce consistency in commit messages and better integrate Cursor with their existing development workflows.

Proposed Solution

  • Introduce a configuration file (e.g., .cursor-config) or UI option where users can specify their desired commit format.
  • Support placeholders (e.g., {type}, {scope}, {description}) to structure the commit message, inspired by widely used conventions like Conventional Commits.
  • Allow users to define default values for placeholders or prompts for missing information during the commit generation process.
  • Provide a preview option for the generated commit message before finalizing it.

Example

A possible configuration might look like:

{
  "commitFormat": "{type}({scope}): {description}",
  "types": ["feat", "fix", "docs", "chore", "refactor"],
  "defaultScope": "general"
}

Related Issues

#2454

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant