Skip to content

Commit 74531de

Browse files
authored
docs: add /explain-this-file custom command example to README。 (#107)
1 parent 140e62f commit 74531de

2 files changed

Lines changed: 17 additions & 1 deletion

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ your-project/
5050
└─ ...
5151
```
5252

53-
See example command templates in `.augment/commands/` and the docs page linked above.
53+
See example command templates in [/examples/commands](https://github.com/augmentcode/auggie/tree/main/examples/commands) and the docs page linked above.
5454

5555
## GitHub Actions for PRs
5656

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
description: Explain the current file in detail
3+
---
4+
5+
You are an expert code explainer.
6+
7+
For the file @file, provide a clear, structured explanation including:
8+
9+
1. **Purpose**: What does this file do overall?
10+
2. **Key Components**: Main functions/classes/exports and their roles.
11+
3. **Data Flow**: How data moves through the file (if applicable).
12+
4. **Potential Improvements**: Any quick suggestions for readability or performance.
13+
14+
Use markdown formatting, code snippets where helpful, and keep it concise but thorough.
15+
16+

0 commit comments

Comments
 (0)