Revise bug report template for improved clarity
Updated bug report template to include detailed fields for better issue tracking.
This commit is contained in:
parent
d58ddecaaf
commit
da121b611d
2 changed files with 139 additions and 44 deletions
44
.github/ISSUE_TEMPLATE/bug_report.md
vendored
44
.github/ISSUE_TEMPLATE/bug_report.md
vendored
|
|
@ -1,44 +0,0 @@
|
|||
---
|
||||
name: Bug report
|
||||
about: Create a report to help us improve
|
||||
title: ''
|
||||
labels: ''
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
## Bug Report
|
||||
|
||||
Thanks for taking the time to report a bug! Your feedback helps make **Presenton** better for everyone.
|
||||
|
||||
Before submitting, please make sure:
|
||||
- You searched existing issues to avoid duplicates
|
||||
- You are using the latest version of Presenton
|
||||
- The problem is reproducible
|
||||
|
||||
### What to Include
|
||||
|
||||
Please provide as much detail as possible so we can reproduce and fix the issue quickly:
|
||||
|
||||
- **Description** – A clear explanation of the problem
|
||||
- **Steps to Reproduce** – Exact steps to reproduce the issue
|
||||
- **Expected Behavior** – What you expected to happen
|
||||
- **Actual Behavior** – What actually happened
|
||||
- **Screenshots or Logs** – If applicable
|
||||
- **Environment Details**
|
||||
- OS (Linux / macOS / Windows)
|
||||
- Docker / Electron / Dev setup
|
||||
- LLM Provider (OpenAI / Gemini / Ollama / Custom)
|
||||
- Browser (if applicable)
|
||||
|
||||
### Example
|
||||
|
||||
```text
|
||||
1. Start Presenton with Docker
|
||||
2. Upload PPTX template
|
||||
3. Generate presentation
|
||||
4. Error occurs when exporting
|
||||
```
|
||||
### Additional Context
|
||||
|
||||
Include any logs, console output, or screenshots that might help us understand the issue.
|
||||
139
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
Normal file
139
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
Normal file
|
|
@ -0,0 +1,139 @@
|
|||
name: Bug report
|
||||
description: Report crashes, regressions, or incorrect behavior in Presenton.
|
||||
title: "[Bug]: "
|
||||
labels:
|
||||
- bug
|
||||
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Thanks for reporting a bug in **Presenton** 🚀
|
||||
Please provide clear steps so we can reproduce and fix the issue quickly.
|
||||
|
||||
- type: dropdown
|
||||
id: bug_type
|
||||
attributes:
|
||||
label: Bug type
|
||||
description: Select the category that best matches the issue.
|
||||
options:
|
||||
- Regression (worked before, now fails)
|
||||
- Crash (app exits or freezes)
|
||||
- UI bug
|
||||
- Generation bug (slides/content incorrect)
|
||||
- Export bug (PPTX/PDF issues)
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: summary
|
||||
attributes:
|
||||
label: Summary
|
||||
description: One sentence describing the issue.
|
||||
placeholder: Exporting a generated presentation as PPTX fails after slide generation.
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: repro
|
||||
attributes:
|
||||
label: Steps to reproduce
|
||||
description: Provide the shortest reproducible steps.
|
||||
placeholder: |
|
||||
1. Start Presenton Electron app
|
||||
2. Generate presentation with 5 slides
|
||||
3. Click "Export PPTX"
|
||||
4. Error occurs
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: expected
|
||||
attributes:
|
||||
label: Expected behavior
|
||||
description: What should happen.
|
||||
placeholder: The presentation should export successfully as a PPTX file.
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: actual
|
||||
attributes:
|
||||
label: Actual behavior
|
||||
description: What happened instead.
|
||||
placeholder: Export fails and the app shows an error message.
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: input
|
||||
id: version
|
||||
attributes:
|
||||
label: Presenton version
|
||||
description: Version of Presenton you are using.
|
||||
placeholder: 0.6.2-beta
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: input
|
||||
id: os
|
||||
attributes:
|
||||
label: Operating system
|
||||
description: OS and version.
|
||||
placeholder: macOS 14 / Ubuntu 24.04 / Windows 11
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: dropdown
|
||||
id: run_method
|
||||
attributes:
|
||||
label: How are you running Presenton?
|
||||
options:
|
||||
- Electron Desktop App
|
||||
- Docker
|
||||
- Local Development
|
||||
- API Only
|
||||
|
||||
- type: dropdown
|
||||
id: llm_provider
|
||||
attributes:
|
||||
label: LLM provider
|
||||
description: AI model provider used for generation.
|
||||
options:
|
||||
- OpenAI
|
||||
- Google Gemini
|
||||
- Anthropic
|
||||
- Ollama
|
||||
- Custom OpenAI-compatible API
|
||||
- Not relevant
|
||||
|
||||
- type: textarea
|
||||
id: logs
|
||||
attributes:
|
||||
label: Logs / screenshots
|
||||
description: Include logs, console output, or screenshots.
|
||||
render: shell
|
||||
|
||||
- type: textarea
|
||||
id: impact
|
||||
attributes:
|
||||
label: Impact
|
||||
description: |
|
||||
Explain how this bug affects usage.
|
||||
|
||||
Include:
|
||||
- Who is affected
|
||||
- Severity
|
||||
- Frequency
|
||||
- Consequence
|
||||
placeholder: |
|
||||
Affected: Users generating AI presentations
|
||||
Severity: High
|
||||
Frequency: Always
|
||||
Consequence: Presentations cannot be exported.
|
||||
|
||||
- type: textarea
|
||||
id: additional_information
|
||||
attributes:
|
||||
label: Additional information
|
||||
description: Any extra context that might help debug the issue.
|
||||
placeholder: Logs from Electron console, template used, or related issues.
|
||||
Loading…
Add table
Reference in a new issue