From d319e7f2ac98f8b99b3ec474ec7311bde0a3dfdb Mon Sep 17 00:00:00 2001 From: 94tianqi <152686371+94tianqi@users.noreply.github.com> Date: Mon, 16 Mar 2026 22:36:33 +0800 Subject: [PATCH 1/3] =?UTF-8?q?docs=EF=BC=9A=20add=20/explain-this-file=20?= =?UTF-8?q?custom=20command=20example=20to=20README=E3=80=82?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/README.md b/README.md index 17b1230..0e3cb19 100644 --- a/README.md +++ b/README.md @@ -52,6 +52,26 @@ your-project/ See example command templates in `.augment/commands/` and the docs page linked above. +#### /explain-this-file + +Create file: `.augment/commands/explain-this-file.md` + +description: Explain the current file in detail +--- + +You are an expert code explainer. + +For the file @file, provide a clear, structured explanation including: + +1. **Purpose**: What does this file do overall? +2. **Key Components**: Main functions/classes/exports and their roles. +3. **Data Flow**: How data moves through the file (if applicable). +4. **Potential Improvements**: Any quick suggestions for readability or performance. + +Use markdown formatting, code snippets where helpful, and keep it concise but thorough. + +Usage: Type /explain-this-file in Auggie while in a file to get an instant breakdown. + ## GitHub Actions for PRs Use our official GitHub Actions to improve PR quality automatically: From af846d13b41749c072fad0b955e783bc325cd8bb Mon Sep 17 00:00:00 2001 From: 94tianqi <152686371+94tianqi@users.noreply.github.com> Date: Tue, 17 Mar 2026 21:52:36 +0800 Subject: [PATCH 2/3] docs: add explain-this-file.md template to examples/commands (addresses feedback) Added the command template file as requested in PR comments. Updated README reference optionally. --- README.md | 2 +- examples/commands/explain-this-file.md | 16 ++++++++++++++++ 2 files changed, 17 insertions(+), 1 deletion(-) create mode 100644 examples/commands/explain-this-file.md diff --git a/README.md b/README.md index 0e3cb19..10869d9 100644 --- a/README.md +++ b/README.md @@ -70,7 +70,7 @@ For the file @file, provide a clear, structured explanation including: Use markdown formatting, code snippets where helpful, and keep it concise but thorough. -Usage: Type /explain-this-file in Auggie while in a file to get an instant breakdown. +See more pre-built examples in [/examples/commands](https://github.com/augmentcode/auggie/tree/main/examples/commands), including the new `/explain-this-file` template. ## GitHub Actions for PRs diff --git a/examples/commands/explain-this-file.md b/examples/commands/explain-this-file.md new file mode 100644 index 0000000..e300aee --- /dev/null +++ b/examples/commands/explain-this-file.md @@ -0,0 +1,16 @@ +--- +description: Explain the current file in detail +--- + +You are an expert code explainer. + +For the file @file, provide a clear, structured explanation including: + +1. **Purpose**: What does this file do overall? +2. **Key Components**: Main functions/classes/exports and their roles. +3. **Data Flow**: How data moves through the file (if applicable). +4. **Potential Improvements**: Any quick suggestions for readability or performance. + +Use markdown formatting, code snippets where helpful, and keep it concise but thorough. + + From c3850652bc850e41d1676bb7fa103d9d43b38b50 Mon Sep 17 00:00:00 2001 From: Justin Xu Date: Tue, 17 Mar 2026 09:15:18 -0700 Subject: [PATCH 3/3] Revise README with updated command examples and links Updated README to include new command template links and removed outdated sections. --- README.md | 22 +--------------------- 1 file changed, 1 insertion(+), 21 deletions(-) diff --git a/README.md b/README.md index 10869d9..53b2c0a 100644 --- a/README.md +++ b/README.md @@ -50,27 +50,7 @@ your-project/ └─ ... ``` -See example command templates in `.augment/commands/` and the docs page linked above. - -#### /explain-this-file - -Create file: `.augment/commands/explain-this-file.md` - -description: Explain the current file in detail ---- - -You are an expert code explainer. - -For the file @file, provide a clear, structured explanation including: - -1. **Purpose**: What does this file do overall? -2. **Key Components**: Main functions/classes/exports and their roles. -3. **Data Flow**: How data moves through the file (if applicable). -4. **Potential Improvements**: Any quick suggestions for readability or performance. - -Use markdown formatting, code snippets where helpful, and keep it concise but thorough. - -See more pre-built examples in [/examples/commands](https://github.com/augmentcode/auggie/tree/main/examples/commands), including the new `/explain-this-file` template. +See example command templates in [/examples/commands](https://github.com/augmentcode/auggie/tree/main/examples/commands) and the docs page linked above. ## GitHub Actions for PRs