Skip to content

Commit 7d4555e

Browse files
committed
docs: improve cursor command documentation
- Rename commit.md to gg_commit.md with enhanced documentation - Add new gg_catalogue.md command documentation - Add VS Code bookmarks configuration
1 parent 670b017 commit 7d4555e

4 files changed

Lines changed: 51 additions & 8 deletions

File tree

.cursor/commands/commit.md

Lines changed: 0 additions & 8 deletions
This file was deleted.

.cursor/commands/gg_catalogue.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# gg_catalogue
2+
3+
`/gg_catalogue` 是一个命令,用于更新目录操作(包括目录中的引用的文件路径以及显示的章节名称),需要执行以下步骤:
4+
5+
1. 确定当前有变更的文件列表(比如通过git status)
6+
2. 如果是新增文件,记得在目录文件SUMMARY.md中添加对应的章节
7+
3. 如果是删除文件,记得在目录文件SUMMARY.md中删除对应的章节
8+
4. 如果是重命名文件,需要先确定旧文件的名称及SUMMARY.md中的章节名称,然后更新为新的文件名称及章节名称
9+
10+
## 注意事项
11+
12+
- 确保在更新目录前已经保存了所有文件变更
13+
- 检查SUMMARY.md的格式是否正确
14+
- 保持章节顺序的逻辑性和连贯性
15+
16+
This command will be available in chat with `/gg_catalogue`

.cursor/commands/gg_commit.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# gg_commit
2+
3+
`/gg_commit [message]` is a command to commit staged changes to the repository.
4+
5+
## Usage
6+
7+
```bash
8+
/gg_commit [message]
9+
```
10+
11+
## Behavior
12+
13+
1. **With message provided**: Commits the staged changes with the provided message.
14+
- Example: `/gg_commit Fix bug in debugger initialization`
15+
16+
2. **Without message**: Automatically generates a commit message by:
17+
- Running `git diff --cached` to analyze staged changes
18+
- Summarizing the changes into an appropriate commit message
19+
- Committing with the generated message
20+
21+
## Workflow
22+
23+
1. Stage your changes using `git add` (if not already staged)
24+
2. Run `/gg_commit` with or without a message
25+
3. The command will create a commit with the appropriate message
26+
27+
## Notes
28+
29+
- Only commits staged changes (files added via `git add`)
30+
- Does not push changes to remote repository
31+
- Automatically generates meaningful commit messages when none provided
32+
- Follows conventional commit message format when possible
33+
34+
This command will be available in chat with `/gg_commit`

.vscode/bookmarks.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{}

0 commit comments

Comments
 (0)