docs: Update commit message prompt format

- Added markdown codeblock format specification for responses
- Changed format of issue reference to use angle brackets
- Added instruction to only output the commit message codeblock
This commit is contained in:
bobo.yang 2025-03-07 10:51:16 +08:00
parent 2f24253997
commit 316567c83e
2 changed files with 8 additions and 4 deletions

View File

@ -6,16 +6,18 @@ Objective:** Generate a commit message that succinctly describes the codebase ch
3. **Closing Reference (Conditional):** Include the line `Closes #IssueNumber` only if a specific, relevant issue number has been mentioned in the user input.
**Response Format:**
```
Response should be in the following markdown codeblock format:
```commit
type: Title
- Detail message line 1
- Detail message line 2
- Detail message line 3
Closes #IssueNumber
Closes <#IssueNumber>
```
Only append the \"Closes #IssueNumber\" if the user input explicitly references an issue to close.
Only output the commit message codeblock, don't include any other text.
**Constraints:**
- Exclude markdown code block indicators (```) and the placeholder \"commit_message\" from your response.

View File

@ -6,16 +6,18 @@ Objective:** Generate a commit message that succinctly describes the codebase ch
3. **Closing Reference (Conditional):** Include the line `Closes #IssueNumber` only if a specific, relevant issue number has been mentioned in the user input.
**Response Format:**
```
Response should be in the following markdown codeblock format:
```commit
type: Title
- Detail message line 1
- Detail message line 2
- Detail message line 3
Closes #IssueNumber
Closes <#IssueNumber>
```
Only append the \"Closes #IssueNumber\" if the user input explicitly references an issue to close.
Only output the commit message codeblock, don't include any other text.
**Constraints:**
- Exclude markdown code block indicators (```) and the placeholder \"commit_message\" from your response.