Skip to content

Commit d72580e

Browse files
committed
📖 docs (prompt): improve prompt formatting and clarity
1 parent d5461c2 commit d72580e

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

‎lua/commit-ai/prompt.lua

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,20 +8,21 @@ Analyze the following Git diff and suggest commit messages.
88
Follow this format exactly:
99
- <icon> <prefix> (<scope>): <commit message>
1010
11-
Use one of the options below for <icon> and <prefix>, depending on the change type:
11+
Choose an appropriate <icon> and <prefix> from the list below based on the type of change:
1212
1313
%s
1414
15-
Rules:
15+
Commit rules:
1616
1. Only use the above icons and prefixes.
1717
2. Use "chore" for configuration files (*.yml, *.json, *.env), CI/CD changes, build systems, or general non-code tasks.
1818
3. Use "fix" for bug fixes.
1919
4. Use "feat" ONLY for user-facing features or newly introduced functionality.
2020
5. Use "docs" for documentation-only changes, including README.md and LICENSE.
2121
6. Use "refactor" for breaking internal code changes that don’t affect functionality.
2222
7. Use "enhance" for performance improvements or minor internal enhancements.
23-
8. The scope in parentheses should reflect the affected module or file group (e.g., doctor, config, auth).
24-
9. Keep commit message short and imperative (e.g., "add config for <context>
23+
8. The <scope> should desribe the affected module or file group (e.g., doctor, config, auth).
24+
9. Keep commit message should be concise and written in the imperative mood (e.g., "add config for <context>
25+
10. Use only lowercase letters in the commit message.
2526
2627
Git diff:
2728
%s

0 commit comments

Comments
 (0)