Skip to content

Commit 3ae39d8

Browse files
committed
docs(settings): update model options and add usage tips
Added model options table formatting and usage tips: - Reorganised Claude model options into individual rows - Added warning note about `allowedTypes` configuration - Added tip for reducing token usage with staged changes - Added tip for temperature setting ranges - Updated temperature description with specific value guidance
1 parent f8f5793 commit 3ae39d8

File tree

1 file changed

+18
-5
lines changed

1 file changed

+18
-5
lines changed

README.md

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,9 @@ Install the extension directly from the [Visual Studio Code Marketplace](https:/
6969

7070
DiffCommit commands can be accessed from the Command Palette (<kbd>Cmd</kbd>/<kbd>Ctrl</kbd> + <kbd>Shift</kbd> + <kbd>P</kbd>) or using the default keyboard shortcuts.
7171

72+
> [!TIP]
73+
> You can reduce token use by staging only part of a group of changes, generating the commit message, then adding the remaining files before committing.
74+
7275
### `DiffCommit: Generate Commit Message`
7376

7477
This will generate a commit message for staged changes and enter it in the Source Control message input box. You can preview and edit the generated message before committing. Progress is shown through notifications as the extension works.
@@ -114,12 +117,15 @@ DiffCommit provides the following settings to customise its behavior.
114117

115118
### `diffCommit.allowedTypes`
116119

117-
A list of allowed commit types. If provided, this replaces the default options.
120+
A list of allowed commit types. If provided, this replaces the default options. You need to ensure all required commit types are included in the list.
118121

119122
| **Type** | **Description** | **Default Value** |
120123
| :------------- | :---------------------------------------------------------------- | :---------------------------------------------------------------------------- |
121124
| Array\<string> | A list (array) of any string/s you want available as commit types | [ "feat", "fix", "refactor", "chore", "docs", "style", "test", "perf", "ci" ] |
122125

126+
> [!WARNING]
127+
> Changing the default, replaces the option value. If you set this option, be sure to include a complete list of all required commit types.
128+
123129
### `diffCommit.customInstructions`
124130

125131
Add additional custom instructions to the commit generation prompt. Useful for providing context or specific requirements like 'Use Australian English spelling'.
@@ -132,9 +138,13 @@ Add additional custom instructions to the commit generation prompt. Useful for p
132138

133139
The Anthropic AI model to use for generating commit messages.
134140

135-
| **Type** | **Options** | **Default Value** |
136-
| :------- | :-------------------------------------------------------------------------------- | :------------------------- |
137-
| enum | "claude-3-opus-latest" \| "claude-3-5-sonnet-latest" \| "claude-3-haiku-20240307" | "claude-3-5-sonnet-latest" |
141+
| **Type** | **Options** | **Default Value** |
142+
| :------- | :------------------------- | :------------------------- |
143+
| enum | "claude-3-5-sonnet-latest" | "claude-3-5-sonnet-latest" |
144+
| | "claude-3-5-haiku-latest" | |
145+
| | "claude-3-opus-latest" | |
146+
| | "claude-3-sonnet-20240229" | |
147+
| | "claude-3-haiku-20240307" | |
138148

139149
### `diffCommit.maxTokens`
140150

@@ -148,7 +158,10 @@ Maximum number of tokens to generate in the response. Higher values allow for lo
148158

149159
Controls randomness in the response. Lower values (like 0.3) produce more focused and consistent commit messages, while higher values introduce more variety.
150160

151-
For concise, focused commit messages, I recommend the default value of 0.3. If you want a little more creativity or room for the AI model to interpret the reason for changes, try a larger value.
161+
> [!TIP]
162+
> For concise, focused & repeatable commit messages, use a value in the range of 0.1 to 0.4.
163+
>
164+
> If you want a little more creativity or more room for the AI model to interpret the reason for changes, try a higher value like 0.7.
152165
153166
| **Type** | **Minimum** | **Maximum** | **Default Value** |
154167
| :------- | :---------: | :---------: | :---------------: |

0 commit comments

Comments
 (0)