Skip to content

Commit bc3fc72

Browse files
committed
docs: standardize command examples with --no_confirm flag
- Remove instructions for previewing commit messages - Update example commands to use the --no_confirm flag instead of --preview - Revise template_string examples to use parentheses around the ticket identifier - Apply --no_confirm to all relevant command usage examples for consistency Signed-off-by: Bo-Yi Wu <[email protected]>
1 parent 997ba50 commit bc3fc72

File tree

1 file changed

+12
-18
lines changed

1 file changed

+12
-18
lines changed

skills/commit-helper/SKILL.md

Lines changed: 12 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -38,42 +38,36 @@ description: Automatically generates conventional commit messages by analyzing y
3838
codegpt commit --no_confirm
3939
```
4040

41-
3. Or preview the message before committing:
42-
43-
```bash
44-
codegpt commit --preview
45-
```
46-
4741
### Advanced Options
4842

4943
- **Set language**: Use `--lang` to specify output language (en, zh-tw, zh-cn)
5044

5145
```bash
52-
codegpt commit --lang zh-tw
46+
codegpt commit --lang zh-tw --no_confirm
5347
```
5448

5549
- **Use specific model**: Override the default model
5650

5751
```bash
58-
codegpt commit --model gpt-4o
52+
codegpt commit --model gpt-4o --no_confirm
5953
```
6054

6155
- **Exclude files**: Ignore certain files from the diff analysis
6256

6357
```bash
64-
codegpt commit --exclude_list "*.lock,*.json"
58+
codegpt commit --exclude_list "*.lock,*.json" --no_confirm
6559
```
6660

6761
- **Custom templates**: Format messages according to your team's style
6862

6963
```bash
70-
codegpt commit --template_string "[{{.summarize_prefix}}] {{.summarize_title}}"
64+
codegpt commit --template_string "[{{.summarize_prefix}}] {{.summarize_title}}" --no_confirm
7165
```
7266

7367
- **Amend commit**: Update the previous commit message
7468

7569
```bash
76-
codegpt commit --amend
70+
codegpt commit --amend --no_confirm
7771
```
7872

7973
## Examples of Inputs and Outputs
@@ -104,7 +98,7 @@ middleware for protecting API endpoints.
10498
```bash
10599
# After fixing a null pointer error
106100
git add src/handlers/user.go
107-
codegpt commit --preview
101+
codegpt commit --no_confirm
108102
```
109103

110104
**Output:**
@@ -156,7 +150,7 @@ feat(JIRA-123): integrate payment gateway API
156150

157151
```bash
158152
git add .
159-
codegpt commit --exclude_list "package-lock.json,yarn.lock,go.sum" --preview
153+
codegpt commit --exclude_list "package-lock.json,yarn.lock,go.sum" --no_confirm
160154
```
161155

162156
**Output:**
@@ -190,7 +184,7 @@ codegpt commit
190184
**Solution**: Increase timeout or commit changes in smaller batches:
191185

192186
```bash
193-
codegpt commit --timeout 60s
187+
codegpt commit --timeout 60s --no_confirm
194188
```
195189

196190
### Generated files in diff
@@ -200,7 +194,7 @@ codegpt commit --timeout 60s
200194
**Solution**: Exclude these files from analysis:
201195

202196
```bash
203-
codegpt commit --exclude_list "package-lock.json,yarn.lock,*.min.js,dist/*"
197+
codegpt commit --exclude_list "package-lock.json,yarn.lock,*.min.js,dist/*" --no_confirm
204198
```
205199

206200
### API key not configured
@@ -220,14 +214,14 @@ codegpt config set openai.api_key "your-api-key-here"
220214
**Solution**: Use custom templates:
221215

222216
```bash
223-
codegpt commit --template_string "[{{.summarize_prefix}}] TICKET-123: {{.summarize_title}}"
217+
codegpt commit --template_string "[{{.summarize_prefix}}](TICKET-123): {{.summarize_title}}"
224218
```
225219

226220
Or save it in config file:
227221

228222
```yaml
229223
git:
230-
template_string: "[{{.summarize_prefix}}] {{.ticket}}: {{.summarize_title}}"
224+
template_string: "[{{.summarize_prefix}}]({{.ticket}}): {{.summarize_title}}"
231225
```
232226
233227
### Multilingual team
@@ -238,7 +232,7 @@ git:
238232
239233
```bash
240234
# Per command
241-
codegpt commit --lang zh-cn
235+
codegpt commit --lang zh-cn --no_confirm
242236

243237
# Or set in repository's .codegpt.yaml
244238
output:

0 commit comments

Comments
 (0)