Skip to content

Commit d05b84c

Browse files
justinxu421justinxu421
committed
Create documentation.md
1 parent 32244e8 commit d05b84c

File tree

15 files changed

+348
-55
lines changed

15 files changed

+348
-55
lines changed

‎.github/workflows/format-check.yml‎

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

‎examples/commands/README.md‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Augment Commands
2+
3+
Pre-built command templates for common development tasks. Use directly or customize for your needs.
4+
5+
## Installation
6+
7+
### Install All Commands
8+
```bash
9+
mkdir -p ~/.augment/commands
10+
cd ~/.augment/commands
11+
curl -O https://raw.githubusercontent.com/augmentcode/auggie/main/examples/commands/code-review.md
12+
curl -O https://raw.githubusercontent.com/augmentcode/auggie/main/examples/commands/documentation.md
13+
curl -O https://raw.githubusercontent.com/augmentcode/auggie/main/examples/commands/tests.md
14+
curl -O https://raw.githubusercontent.com/augmentcode/auggie/main/examples/commands/bug-fix.md
15+
curl -O https://raw.githubusercontent.com/augmentcode/auggie/main/examples/commands/performance-optimization.md
16+
curl -O https://raw.githubusercontent.com/augmentcode/auggie/main/examples/commands/security-review.md
17+
```
18+
19+
### Install Specific Commands
20+
```bash
21+
mkdir -p ~/.augment/commands
22+
cd ~/.augment/commands
23+
curl -O https://raw.githubusercontent.com/augmentcode/auggie/main/examples/commands/code-review.md
24+
curl -O https://raw.githubusercontent.com/augmentcode/auggie/main/examples/commands/documentation.md
25+
```
26+
27+
## Usage
28+
29+
```bash
30+
augment code-review src/main.py
31+
augment documentation src/utils.py
32+
augment tests src/api/
33+
```
34+
35+
## Available Commands
36+
37+
- `code-review.md` - Code quality checks
38+
- `documentation.md` - Documentation generation
39+
- `tests.md` - Test coverage
40+
- `bug-fix.md` - Debugging assistance
41+
- `performance-optimization.md` - Performance improvements
42+
- `security-review.md` - Security analysis
43+
44+
## Customization
45+
46+
Edit the `.md` files to modify prompts, change models, or adjust behavior for your needs.

‎examples/commands/bug-fix.md‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
description: Generate a structured bug fix approach
3+
argument-hint: [bug-description]
4+
model: gpt5
5+
---
6+
7+
Help me fix this bug: $ARGUMENTS
8+
9+
Please provide:
10+
11+
1. Root cause analysis
12+
2. Step-by-step fix approach
13+
3. Testing strategy
14+
4. Prevention measures for similar issues

‎examples/commands/code-review.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
description: Perform a comprehensive code review
3+
argument-hint: [file-path]
4+
model: gpt5
5+
---
6+
7+
Please perform a comprehensive code review of the specified file or current changes, focusing on:
8+
9+
1. Code Quality: Check for readability, maintainability, and adherence to best practices
10+
2. Security: Look for potential security vulnerabilities
11+
3. Performance: Identify potential performance issues
12+
4. Testing: Suggest areas that need test coverage
13+
5. Documentation: Check if code is properly documented
14+
15+
$ARGUMENTS

‎examples/commands/documentation.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
description: Generate comprehensive documentation
3+
argument-hint: [file-or-component]
4+
model: gpt5
5+
---
6+
7+
Generate documentation for: $ARGUMENTS
8+
9+
Include:
10+
11+
1. Overview and purpose
12+
2. API reference with parameters and return values
13+
3. Usage examples with code snippets
14+
4. Configuration options if applicable
15+
5. Error handling and troubleshooting
16+
6. Dependencies and requirements
17+
18+
Format as clear, structured markdown.

‎examples/commands/performance-optimization.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
description: Analyze and optimize code performance
3+
argument-hint: [file-path]
4+
model: gpt5
5+
---
6+
7+
Analyze the performance of: $ARGUMENTS
8+
9+
Please examine:
10+
11+
1. Algorithm complexity and efficiency
12+
2. Memory usage patterns
13+
3. Database queries and optimization opportunities
14+
4. Caching strategies
15+
5. Network requests and bundling
16+
6. Rendering performance (for frontend code)
17+
18+
Suggest specific optimizations with expected impact.

‎examples/commands/security-review.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
description: Perform security analysis on code
3+
argument-hint: [file-path]
4+
model: gpt5
5+
---
6+
7+
Perform a security review of: $ARGUMENTS
8+
9+
Focus on:
10+
11+
1. Input validation and sanitization
12+
2. Authentication and authorization checks
13+
3. Data exposure and privacy concerns
14+
4. Injection vulnerabilities (SQL, XSS, etc.)
15+
5. Cryptographic implementations
16+
6. Dependencies with known vulnerabilities
17+
18+
Provide specific recommendations for any issues found.

‎examples/commands/tests.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
description: Generate comprehensive test cases
3+
argument-hint: [file-or-module]
4+
model: gpt5
5+
---
6+
7+
Generate test cases for: $ARGUMENTS
8+
9+
Create tests covering:
10+
11+
1. Happy path scenarios
12+
2. Edge cases and boundary conditions
13+
3. Error handling and exceptions
14+
4. Integration points with other components
15+
5. Performance considerations
16+
6. Security edge cases
17+
18+
Use appropriate testing framework conventions and include setup/teardown as needed.

‎examples/workflows/README.md‎

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
# GitHub Workflows
2+
3+
GitHub Actions workflows for integrating Augment's AI-powered code review and PR descriptions.
4+
5+
## Installation
6+
7+
### Install All Workflows
8+
```bash
9+
mkdir -p .github/workflows
10+
cd .github/workflows
11+
curl -O https://raw.githubusercontent.com/augmentcode/auggie/main/examples/workflows/describe-pr.yml
12+
curl -O https://raw.githubusercontent.com/augmentcode/auggie/main/examples/workflows/pr-review.yml
13+
curl -O https://raw.githubusercontent.com/augmentcode/auggie/main/examples/workflows/on-demand-description.yml
14+
curl -O https://raw.githubusercontent.com/augmentcode/auggie/main/examples/workflows/on-demand-review.yml
15+
curl -O https://raw.githubusercontent.com/augmentcode/auggie/main/examples/workflows/release.yml
16+
curl -O https://raw.githubusercontent.com/augmentcode/auggie/main/examples/workflows/test-action.yml
17+
git add .github/workflows/
18+
git commit -m "Add Augment AI workflows"
19+
git push
20+
```
21+
22+
### Install Specific Workflows
23+
```bash
24+
mkdir -p .github/workflows
25+
cd .github/workflows
26+
curl -O https://raw.githubusercontent.com/augmentcode/auggie/main/examples/workflows/describe-pr.yml
27+
curl -O https://raw.githubusercontent.com/augmentcode/auggie/main/examples/workflows/pr-review.yml
28+
git add .github/workflows/
29+
git commit -m "Add Augment AI workflows"
30+
git push
31+
```
32+
33+
## Setup
34+
35+
**Required Secret**: Add `AUGMENT_SESSION_AUTH` to your repository:
36+
1. Go to Settings → Secrets and variables → Actions
37+
2. Click "New repository secret"
38+
3. Name: `AUGMENT_SESSION_AUTH`
39+
4. Value: Your Augment session authentication token
40+
41+
## Available Workflows
42+
43+
**Automatic**:
44+
- `describe-pr.yml` - Auto-generates PR descriptions
45+
- `pr-review.yml` - Auto-reviews new PRs
46+
47+
**On-Demand** (triggered by labels):
48+
- `on-demand-description.yml` - Add `augment_describe` label
49+
- `on-demand-review.yml` - Add `augment_review` label
50+
51+
**Other**:
52+
- `release.yml` - Automated release notes
53+
- `test-action.yml` - Manual testing
54+
55+
## Customization
56+
57+
Edit the `.yml` files to modify triggers, parameters, or add additional steps.

‎examples/workflows/describe-pr.yml‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Basic PR Description Generation
2+
# Automatically generates AI-powered descriptions for new pull requests
3+
4+
name: Auto-describe PRs
5+
on:
6+
pull_request:
7+
types: [opened]
8+
9+
jobs:
10+
describe:
11+
runs-on: ubuntu-latest
12+
permissions:
13+
contents: read
14+
pull-requests: write
15+
steps:
16+
- name: Generate PR Description
17+
uses: augmentcode/describe-pr@v0
18+
with:
19+
augment_session_auth: ${{ secrets.AUGMENT_SESSION_AUTH }}
20+
github_token: ${{ secrets.GITHUB_TOKEN }}
21+
pull_number: ${{ github.event.pull_request.number }}
22+
repo_name: ${{ github.repository }}
23+

0 commit comments

Comments
 (0)