Files
openmaic/OpenMAIC/.github/ISSUE_TEMPLATE/bug_report.yml
2026-08-16 14:58:47 +08:00

125 lines
3.3 KiB
YAML

name: Bug Report
description: Report a bug or unexpected behavior
title: "[Bug]: "
labels: ["bug"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to report a bug! Please fill out the information below to help us investigate.
Before submitting, please search existing issues for duplicates and remove API keys, access tokens, personal data, and other secrets from logs, screenshots, or recordings.
- type: textarea
id: description
attributes:
label: Bug Description
description: A clear and concise description of the bug.
placeholder: Describe what happened...
validations:
required: true
- type: textarea
id: steps
attributes:
label: Steps to Reproduce
description: How can we reproduce this issue?
placeholder: |
1. Go to '...'
2. Click on '...'
3. See error
validations:
required: true
- type: textarea
id: expected
attributes:
label: Expected Behavior
description: What did you expect to happen?
validations:
required: true
- type: textarea
id: actual
attributes:
label: Actual Behavior
description: What actually happened?
validations:
required: true
- type: dropdown
id: deployment
attributes:
label: Deployment Method
options:
- Local development (npm run dev / pnpm dev / yarn dev)
- Vercel deployment
- Docker
- Other
validations:
required: true
- type: input
id: version
attributes:
label: OpenMAIC Version
description: Which release, commit SHA, or Docker image tag are you using?
placeholder: e.g. v0.4.2, 40ff80a, or latest
validations:
required: true
- type: dropdown
id: area
attributes:
label: Affected Area
description: Which part of OpenMAIC is affected?
options:
- Classroom generation
- Playback / presentation
- Editor / canvas
- Import / export
- Model / provider integration
- Storage / persistence
- Deployment / infrastructure
- Documentation
- Other
validations:
required: true
- type: input
id: browser
attributes:
label: Browser
description: Which browser are you using? Enter "Not applicable" for non-browser issues.
placeholder: e.g. Chrome 120, Firefox 121, Safari 17, or Not applicable
validations:
required: true
- type: input
id: os
attributes:
label: Operating System
description: Which operating system are you using? Enter "Not applicable" for non-runtime issues.
placeholder: e.g. macOS 14.2, Windows 11, Ubuntu 22.04, or Not applicable
validations:
required: true
- type: textarea
id: logs
attributes:
label: Relevant Logs
description: Paste error messages and console or server logs after removing secrets and personal data.
render: shell
- type: textarea
id: screenshots
attributes:
label: Screenshots or Recordings
description: Attach screenshots or recordings after removing secrets and personal data.
- type: textarea
id: additional
attributes:
label: Additional Context
description: Any other information that might be helpful.