Skip to content

Commit 1220d55

Browse files
justinxu421justinxu421
committed
Initial commit
initial README for auggie
0 parents  commit 1220d55

17 files changed

+693
-0
lines changed

‎.augment/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

‎.augment/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

‎.augment/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.

‎.augment/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.

‎.augment/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.

‎.augment/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.

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
name: "Bug Report"
2+
description: "Report a bug to help us improve this project"
3+
title: "[Bug]: "
4+
5+
labels:
6+
- "bug"
7+
- "kind/bug"
8+
- "status/need-triage"
9+
body:
10+
- type: "markdown"
11+
attributes:
12+
value: |-
13+
> [!IMPORTANT]
14+
> Thanks for taking the time to fill out this bug report!
15+
>
16+
> Please search **[existing issues](./issues)** to see if an issue already exists for the bug you encountered.
17+
18+
- type: "textarea"
19+
id: "problem"
20+
attributes:
21+
label: "What happened?"
22+
description: "A clear and concise description of what the bug is."
23+
validations:
24+
required: true
25+
26+
- type: "textarea"
27+
id: "expected"
28+
attributes:
29+
label: "What did you expect to happen?"
30+
validations:
31+
required: true
32+
33+
- type: "textarea"
34+
id: "reproduction"
35+
attributes:
36+
label: "Steps to reproduce"
37+
description: "List the steps to reproduce the issue. Include commands, inputs, and observed output."
38+
value: |-
39+
1.
40+
2.
41+
3.
42+
43+
- type: "input"
44+
id: "auggie-version"
45+
attributes:
46+
label: "Auggie version"
47+
description: "Output of `auggie --version`"
48+
placeholder: "e.g., 0.9.1"
49+
validations:
50+
required: true
51+
52+
- type: "input"
53+
id: "request-id"
54+
attributes:
55+
label: "Request ID"
56+
description: "From `/request-id` (or include the ID shown in error output/logs)"
57+
placeholder: "e.g., req_123abc456def"
58+
validations:
59+
required: true
60+
- type: "textarea"
61+
id: "environment"
62+
attributes:
63+
label: "Environment details"
64+
description: "OS, runtime, tool versions, and any other relevant environment info."
65+
value: |-
66+
<details>
67+
<summary>Environment</summary>
68+
69+
- OS:
70+
- Shell:
71+
- Tool/CLI version:
72+
73+
</details>
74+
75+
- type: "textarea"
76+
id: "additional-context"
77+
attributes:
78+
label: "Anything else we need to know?"
79+
description: "Logs, screenshots, or other context that helps diagnose the problem."

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
name: "Feature Request"
2+
description: "Suggest an idea for this project"
3+
title: "[Feature]: "
4+
labels:
5+
- "enhancement"
6+
- "kind/enhancement"
7+
- "status/need-triage"
8+
body:
9+
- type: "markdown"
10+
attributes:
11+
value: |-
12+
> [!IMPORTANT]
13+
> Thanks for taking the time to suggest an enhancement!
14+
>
15+
> Please search **[existing issues](./issues)** to see if a similar feature has already been requested.
16+
17+
- type: "textarea"
18+
id: "feature"
19+
attributes:
20+
label: "What would you like to be added?"
21+
description: "A clear and concise description of the enhancement."
22+
validations:
23+
required: true
24+
25+
- type: "textarea"
26+
id: "rationale"
27+
attributes:
28+
label: "Why is this needed?"
29+
description: "A clear and concise description of why this enhancement is needed."
30+
validations:
31+
required: true
32+
33+
- type: "textarea"
34+
id: "solution-ideas"
35+
attributes:
36+
label: "Possible solution or alternatives"
37+
description: "If you have ideas for how to implement it, or alternatives you considered, add them here."
38+
39+
- type: "textarea"
40+
id: "additional-context"
41+
attributes:
42+
label: "Additional context"
43+
description: "Add any other context or screenshots about the feature request here."

‎.github/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+

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

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
name: Format Check
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
pull_request:
8+
types: [opened, synchronize]
9+
branches:
10+
- main
11+
12+
jobs:
13+
format-check:
14+
runs-on: ubuntu-latest
15+
steps:
16+
- name: Checkout
17+
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
18+
19+
- name: Probe repository for Bun format check
20+
id: probe
21+
shell: bash
22+
run: |
23+
if [ -f bun.lockb ] && [ -f package.json ] && grep -q '"format:check"' package.json; then
24+
echo "run=true" >> "$GITHUB_OUTPUT"
25+
else
26+
echo "run=false" >> "$GITHUB_OUTPUT"
27+
fi
28+
29+
- name: Setup Bun
30+
if: steps.probe.outputs.run == 'true'
31+
uses: oven-sh/setup-bun@735343b667d3e6f658f44d0eca948eb6282f2b76 # v2.0.2
32+
with:
33+
bun-version: latest
34+
35+
- name: Install dependencies
36+
if: steps.probe.outputs.run == 'true'
37+
run: bun install --frozen-lockfile
38+
39+
- name: Check formatting
40+
if: steps.probe.outputs.run == 'true'
41+
run: bun run format:check
42+
43+
- name: Check if files would change
44+
if: steps.probe.outputs.run == 'true'
45+
run: |
46+
if ! git diff --exit-code; then
47+
echo "❌ Files are not properly formatted. Run 'bun run format' to fix."
48+
exit 1
49+
else
50+
echo "✅ All files are properly formatted."
51+
fi
52+
53+
- name: Skip - No Bun format check configured
54+
if: steps.probe.outputs.run != 'true'
55+
run: echo "Skipping format check (no bun.lockb and format:check script)."

0 commit comments

Comments
 (0)