feat(system): Issue templates: simplified bug report + new feedback form (#196)
Co-authored-by: @devpulse <devpulse@aipass>
This commit is contained in:
@@ -6,85 +6,48 @@ body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Thanks for reporting a bug. Please fill out the sections below so we can reproduce and fix the issue.
|
||||
|
||||
- type: checkboxes
|
||||
id: checklist
|
||||
attributes:
|
||||
label: Pre-submission checklist
|
||||
options:
|
||||
- label: I searched existing issues and didn't find a duplicate
|
||||
required: true
|
||||
- label: I verified this happens with the latest version
|
||||
required: true
|
||||
- label: I can reproduce this bug consistently
|
||||
required: true
|
||||
Found a bug? Tell us what happened. Keep it simple — we'll ask for more details if we need them.
|
||||
|
||||
- type: textarea
|
||||
id: description
|
||||
attributes:
|
||||
label: Description
|
||||
description: A clear description of the bug.
|
||||
placeholder: "Describe what happened and what you expected to happen..."
|
||||
label: What happened?
|
||||
description: Describe the bug. What did you do, and what went wrong?
|
||||
placeholder: "I tried to ... and instead of ... it ..."
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: steps
|
||||
attributes:
|
||||
label: Steps to Reproduce
|
||||
description: Step-by-step instructions to reproduce the bug.
|
||||
label: Steps to reproduce (if you know them)
|
||||
description: Optional but helpful. How can we trigger this?
|
||||
placeholder: |
|
||||
1. Install aipass v2.x.x
|
||||
2. Run `aipass ...`
|
||||
3. Observe error
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: expected
|
||||
attributes:
|
||||
label: Expected Behavior
|
||||
description: What did you expect to happen?
|
||||
|
||||
- type: textarea
|
||||
id: actual
|
||||
attributes:
|
||||
label: Actual Behavior
|
||||
description: What actually happened instead?
|
||||
|
||||
- type: textarea
|
||||
id: reproduction
|
||||
attributes:
|
||||
label: Minimal Reproducible Example
|
||||
description: Provide the smallest amount of code that reproduces the bug.
|
||||
placeholder: |
|
||||
from aipass import ...
|
||||
|
||||
# minimal code to trigger the bug
|
||||
render: python
|
||||
|
||||
- type: textarea
|
||||
id: error
|
||||
attributes:
|
||||
label: Full Error Output / Stack Trace
|
||||
description: Copy the complete error output, including the full stack trace.
|
||||
render: shell
|
||||
1. Run ...
|
||||
2. Then ...
|
||||
3. See error
|
||||
|
||||
- type: textarea
|
||||
id: environment
|
||||
attributes:
|
||||
label: Environment
|
||||
description: Your environment details.
|
||||
description: What are you running on?
|
||||
placeholder: |
|
||||
- Python: 3.12.0
|
||||
- OS: Ubuntu 24.04
|
||||
- aipass: 2.1.69
|
||||
- Python: 3.12
|
||||
- CLI: Claude Code / Codex / Gemini
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: error
|
||||
attributes:
|
||||
label: Error output (if any)
|
||||
description: Paste any error messages or stack traces.
|
||||
render: shell
|
||||
|
||||
- type: textarea
|
||||
id: additional
|
||||
attributes:
|
||||
label: Additional Context
|
||||
description: Anything else we should know? Screenshots, logs, related issues, etc.
|
||||
label: Anything else?
|
||||
description: Screenshots, logs, context — whatever helps.
|
||||
|
||||
@@ -0,0 +1,47 @@
|
||||
name: Feedback
|
||||
description: Share feedback, thoughts, or suggestions
|
||||
title: "[Feedback]: "
|
||||
labels: ["feedback"]
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
We'd love to hear from you. Bug reports and feature requests have their own templates — this one is for everything else.
|
||||
|
||||
- type: input
|
||||
id: name
|
||||
attributes:
|
||||
label: Name
|
||||
description: What should we call you?
|
||||
placeholder: "Your name"
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: input
|
||||
id: email
|
||||
attributes:
|
||||
label: Email (optional)
|
||||
description: Only if you'd like us to follow up directly. Never shared.
|
||||
placeholder: "you@example.com"
|
||||
|
||||
- type: dropdown
|
||||
id: type
|
||||
attributes:
|
||||
label: What kind of feedback?
|
||||
options:
|
||||
- General feedback
|
||||
- Something I liked
|
||||
- Something that confused me
|
||||
- Suggestion
|
||||
- Question
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: message
|
||||
attributes:
|
||||
label: Your feedback
|
||||
description: Tell us what's on your mind.
|
||||
placeholder: "I tried AIPass and..."
|
||||
validations:
|
||||
required: true
|
||||
Reference in New Issue
Block a user