Skip to content

Commit 4363a98

Browse files
hwwnhwwn
committed
docs: add issue templates (bug, feature, config)
- Bug report form: prerequisites, version, OS+version, provider used, repro steps, expected behavior, optional logs/tier. - Feature request form: prerequisites, problem framing, proposal, alternatives, scope dropdown, optional tier (VVIP gets priority). - config.yml: disable blank issues so users pick a template, and route security reports to the private vulnerability flow plus quick links to provider guide / website / pricing.
1 parent 51823cd commit 4363a98

3 files changed

Lines changed: 225 additions & 0 deletions

File tree

‎.github/ISSUE_TEMPLATE/bug_report.yml‎

Lines changed: 125 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,125 @@
1+
name: 🐛 Bug report
2+
description: Something is broken or behaving unexpectedly in AAA Code.
3+
title: "[Bug]: "
4+
labels: ["bug", "needs-triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for taking the time to file a bug report. The more concrete this is, the faster it gets fixed.
10+
11+
> 🔒 If this is a **security** issue (data leak, RCE, auth bypass, anything that puts user keys/data at risk), **please do not file it here**. Use [private vulnerability reporting](https://github.com/hwwn/aaa-code-release/security/advisories/new) instead.
12+
13+
- type: checkboxes
14+
id: prerequisites
15+
attributes:
16+
label: Before you file
17+
options:
18+
- label: I'm running the **latest release** from the [Releases page](https://github.com/hwwn/aaa-code-release/releases).
19+
required: true
20+
- label: I [searched existing issues](https://github.com/hwwn/aaa-code-release/issues?q=is%3Aissue) and didn't find a duplicate.
21+
required: true
22+
- label: This is **not** a security vulnerability (if it is, I'll close this and use private reporting).
23+
required: true
24+
25+
- type: input
26+
id: version
27+
attributes:
28+
label: AAA Code version
29+
description: Find it in `Settings → About`, or copy the release tag you downloaded.
30+
placeholder: e.g. 0.4.5
31+
validations:
32+
required: true
33+
34+
- type: dropdown
35+
id: os
36+
attributes:
37+
label: Operating system
38+
options:
39+
- macOS (Apple Silicon)
40+
- macOS (Intel)
41+
- Windows 11
42+
- Windows 10
43+
- Linux (.AppImage)
44+
- Linux (.deb)
45+
- Other (please specify in description)
46+
validations:
47+
required: true
48+
49+
- type: input
50+
id: os_version
51+
attributes:
52+
label: OS version
53+
placeholder: e.g. macOS 15.3, Windows 11 23H2, Ubuntu 24.04
54+
validations:
55+
required: true
56+
57+
- type: dropdown
58+
id: provider
59+
attributes:
60+
label: LLM provider being used
61+
description: Which provider was active when the bug happened?
62+
options:
63+
- Anthropic (direct)
64+
- DeepSeek
65+
- Zhipu
66+
- Kimi (Moonshot)
67+
- MiniMax
68+
- AWS Bedrock
69+
- Google Vertex
70+
- LiteLLM proxy / custom endpoint
71+
- Not provider-related
72+
- Other (please specify in description)
73+
validations:
74+
required: true
75+
76+
- type: textarea
77+
id: what_happened
78+
attributes:
79+
label: What happened?
80+
description: A clear, concise description of the bug. Screenshots / screen recordings welcome (drag-and-drop into the box).
81+
placeholder: |
82+
I clicked X, expected Y, but Z happened instead.
83+
validations:
84+
required: true
85+
86+
- type: textarea
87+
id: repro
88+
attributes:
89+
label: Steps to reproduce
90+
description: Numbered steps so we can hit the same thing on our end.
91+
placeholder: |
92+
1. Open AAA Code
93+
2. Go to ...
94+
3. Click ...
95+
4. See error
96+
validations:
97+
required: true
98+
99+
- type: textarea
100+
id: expected
101+
attributes:
102+
label: Expected behavior
103+
placeholder: I expected Claude to ...
104+
validations:
105+
required: true
106+
107+
- type: textarea
108+
id: logs
109+
attributes:
110+
label: Logs / console output
111+
description: |
112+
Paste any relevant log lines or stack traces. **Redact API keys, tokens, and personal data first.**
113+
On macOS: `~/Library/Logs/AAA Code/`. On Windows: `%APPDATA%/AAA Code/logs/`. On Linux: `~/.config/AAA Code/logs/`.
114+
render: shell
115+
validations:
116+
required: false
117+
118+
- type: input
119+
id: tier
120+
attributes:
121+
label: Plan tier (optional)
122+
description: If you're a paid user, mentioning your tier helps us prioritize.
123+
placeholder: Free / Member / VIP / VVIP
124+
validations:
125+
required: false

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: 🔒 Report a security vulnerability
4+
url: https://github.com/hwwn/aaa-code-release/security/advisories/new
5+
about: Please use the private vulnerability reporting flow — do NOT open a public issue for security problems.
6+
- name: 📖 Provider setup guide
7+
url: https://aaa-code.app/guides/providers
8+
about: Configuring Anthropic, DeepSeek, Zhipu, Kimi, MiniMax, Bedrock, Vertex, or LiteLLM as your LLM backend.
9+
- name: 🌐 Website & download
10+
url: https://aaa-code.app
11+
about: Latest release, screenshots, pricing, and what makes AAA Code different.
12+
- name: 💎 Pricing & tiers
13+
url: https://aaa-code.app/#pricing
14+
about: Member / VIP / VVIP — VVIP includes priority on feature requests and direct email support.

‎.github/ISSUE_TEMPLATE/feature_request.yml‎

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
name: ✨ Feature request
2+
description: Suggest a new capability or an improvement to AAA Code.
3+
title: "[Feature]: "
4+
labels: ["enhancement", "needs-triage"]
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Thanks for the suggestion. The most useful feature requests describe a **real workflow** you're trying to do — even more than they describe a specific UI.
10+
11+
> 💎 **VVIP members** get priority on feature requests. Mention your tier below if applicable.
12+
13+
- type: checkboxes
14+
id: prerequisites
15+
attributes:
16+
label: Before you file
17+
options:
18+
- label: I [searched existing issues](https://github.com/hwwn/aaa-code-release/issues?q=is%3Aissue) and didn't find a duplicate or similar request.
19+
required: true
20+
- label: This is genuinely about AAA Code (not about Claude Code itself or upstream Anthropic features).
21+
required: true
22+
23+
- type: textarea
24+
id: problem
25+
attributes:
26+
label: What's the problem?
27+
description: |
28+
What are you trying to do today, and what's painful about it? **Skip the solution for now** — describe the friction.
29+
placeholder: |
30+
When I'm working across two projects, I currently have to ... and that means ...
31+
validations:
32+
required: true
33+
34+
- type: textarea
35+
id: proposal
36+
attributes:
37+
label: Proposed solution
38+
description: How would you like AAA Code to behave?
39+
placeholder: |
40+
I'd like a button / shortcut / setting that ...
41+
validations:
42+
required: true
43+
44+
- type: textarea
45+
id: alternatives
46+
attributes:
47+
label: Alternatives you've considered
48+
description: Workarounds you've already tried, or other tools that solve this differently.
49+
placeholder: |
50+
I've tried doing X with Y, but ...
51+
validations:
52+
required: false
53+
54+
- type: dropdown
55+
id: scope
56+
attributes:
57+
label: Where does this fit?
58+
options:
59+
- Remote / Mobile
60+
- Multi-CWD / Workspaces
61+
- Sessions / Forking
62+
- Providers / API keys
63+
- Themes / UI
64+
- Scheduling
65+
- CLI + GUI parity
66+
- Settings / preferences
67+
- Other (explain in description)
68+
validations:
69+
required: true
70+
71+
- type: input
72+
id: tier
73+
attributes:
74+
label: Plan tier (optional)
75+
description: VVIP requests are prioritized. Free / Member / VIP requests are still very welcome — just be aware of queue order.
76+
placeholder: Free / Member / VIP / VVIP
77+
validations:
78+
required: false
79+
80+
- type: textarea
81+
id: extra
82+
attributes:
83+
label: Anything else
84+
description: Mockups, screenshots from other apps, links, half-formed thoughts — all welcome.
85+
validations:
86+
required: false

0 commit comments

Comments
 (0)