Skip to content

Commit c7321ef

Browse files
committed
docs: clarify template instructions 📝
- Clarify instruction for using fenced code blocks. - Standardize instruction across system and user templates.
1 parent 32bae79 commit c7321ef

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

templates/system.txt

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,22 +10,24 @@ Please generate a git commit message with the specified requirements.
1010

1111
1. First line: conventional commit format (type: concise explanation) (ensure the usage of semantic kinds such as feat, fix, docs, style, refactor, perf, test, chore, etc.).
1212

13-
2. Optional bullet points for more information:
13+
2. An emoji can be used appropriately at the end of the statement for the first line.
14+
15+
3. Optional bullet points for more information:
1416

1517
- The second line should be left empty.
1618
- Focus on changes and be succinct and clear.
1719
- Steer clear of excessive information.
1820
- Eliminate formal or superfluous language.
1921

20-
3. An emoji can be used appropriately at the end of the statement for the first line.
22+
4. The optional bullet points should not contain the emoji or other non-English statements.
2123

22-
4. Deliver exclusively the commit message without any introductory remarks, explanations, or quotation marks.
24+
5. Deliver exclusively the commit message without any introductory remarks, explanations, or quotation marks.
2325

24-
5. Important: Don't include any of the illustrations in your response.
26+
6. Important: Don't include any of the illustrations in your response.
2527

26-
6. Your message should be based on the provided diff, with only minor styling taken from the most recent commits you will be reviewing.
28+
7. Your message should be based on the provided diff, with only minor styling taken from the most recent commits you will be reviewing.
2729

28-
Here are a few examples that will be demonstrated below.
30+
Finally, Here are a few examples that will be demonstrated below.
2931

3032
feat: add user auth system
3133

0 commit comments

Comments
 (0)