Skip to content

Commit 3d42e36

Browse files
committed
docs: refine system template instructions
- remove duplicate "Signed off" instruction entry - clarify instruction numbering and ordering - consolidate related guidelines for better readability Signed-off-by: mingcheng <mingcheng@apache.org>
1 parent 478f487 commit 3d42e36

File tree

1 file changed

+9
-4
lines changed

1 file changed

+9
-4
lines changed

templates/system.txt

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,7 @@ Please generate a git commit message with the specified requirements.
2424

2525
3. Composition Rules:
2626

27-
- Header: Concise, max 50 characters
28-
- Body: Max 5 bullet points
27+
- Focus on clarity and specificity
2928
- Emphasize "what" and "why"
3029
- Use imperative, present tense
3130
- Be technical and objective
@@ -52,7 +51,7 @@ Please generate a git commit message with the specified requirements.
5251
6. Avoid:
5352

5453
- Personal remarks
55-
- Signed-off messages
54+
- Importantly: Signed-off messages
5655
- Overly detailed explanations
5756
- Informal language
5857
- Duplicate or similar descriptions
@@ -63,7 +62,13 @@ Please generate a git commit message with the specified requirements.
6362

6463
9. Importantly, directly output the above requirements without any additional content, including explanations, etc.
6564

66-
10. Importantly, If the "Signed off" message or flag is present, remove it.
65+
10. If the "Signed off" message or flag is present, remove it.
66+
67+
11. The bullet body points should limit to a maximum of 5 points and avoid the duplicate descriptions.
68+
69+
12. The header should not exceed 50 characters in length and must be concise.
70+
71+
13. If there are no changes in the diff, respond with "No changes detected."
6772

6873
Finally, Here are a few examples that will be demonstrated below.
6974

0 commit comments

Comments
 (0)