Skip to content

Commit 5556b65

Browse files
committed
Clarify commit message API structure and add default instructions
1 parent 59e96bf commit 5556b65

1 file changed

Lines changed: 7 additions & 4 deletions

File tree

docs/features/generate-commit-message.mdx

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,19 +3,22 @@ title: Generate Commit Message
33
sidebar_position: 5
44
---
55

6-
Code Web Chat's Generate Commit Message feature automatically creates meaningful commit messages. This saves you time and ensures your commit history remains descriptive and consistent.
6+
Generate meaningful commit messages precisely adhering to your preffered style.
77

88
## API message structure
99

1010
```
11+
[INSTRUCTIONS]
1112
<files>
1213
<file path="...">...</file>
13-
// other affected files...
14+
// other affected files
1415
</files>
15-
Write a brief and precise summary for the following diff, limited to a single sentence if possible and nothing else. Use an imperative tone to ensure clarity and focus on the primary change or purpose.
16-
[DIFF OF CHANGES]
16+
[DIFFS]
17+
[INSTRUCTIONS]
1718
```
1819

20+
**Default instructions:** Write a brief and precise summary for the changes, limited to a single sentence if possible and nothing else. Use an imperative tone to ensure clarity and focus on the primary change or purpose.
21+
1922
## Settings
2023

2124
##### `Code Web Chat: Commit Message Instructions`

0 commit comments

Comments
 (0)