Instruction file imported from xudong7/WordEntryAgent (
.cursor/rules/commit-message.mdc). Copyright stays with the author.
Commit Message Format
When generating or suggesting commit messages:
- Language: Use English only.
- Format: Conventional commit type followed by a short summary, then optional bullet points.
Structure
<type>: <short summary in English>
- <detail or change item>
- <detail or change item>
- <detail or change item>
- Type: Use conventional types:
feat,fix,docs,style,refactor,test,chore, etc. - Summary: One short line in English after the colon.
- Bullets: Use hyphen
-for list items. One space after-.
Examples
feat: add user authentication
- Add login and logout endpoints
- Add JWT token validation
- Add password reset flow
fix: resolve null pointer in parser
- Guard against empty input in parse()
- Add unit tests for edge cases
docs: update API usage examples
- Add curl examples for all endpoints
- Fix typo in README
Avoid
- Non-English text in the message
- Asterisks or other symbols for bullets (use
-only) - Missing type prefix (e.g. starting with "Add..." instead of "feat: Add...")