- Add structured bug report template with component selection, environment details, and reproduction steps - Add feature request template with priority levels, breaking change indicators, and use case descriptions - Templates aligned with project components including API endpoints, admin interface, barcode generation, and Entra ID authentication
128 lines
3.3 KiB
YAML
128 lines
3.3 KiB
YAML
name: Bug Report
|
|
description: Report a bug or issue with the Flask AR API Demo Server
|
|
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 resolve the issue.
|
|
|
|
- type: dropdown
|
|
id: component
|
|
attributes:
|
|
label: Component
|
|
description: Which component is affected?
|
|
options:
|
|
- API Endpoints (login, arcontentfields, arinfo)
|
|
- Admin Interface
|
|
- Barcode Generation
|
|
- Image Serving
|
|
- Authentication (Entra ID)
|
|
- Database/Models
|
|
- Other
|
|
validations:
|
|
required: true
|
|
|
|
- type: textarea
|
|
id: description
|
|
attributes:
|
|
label: Bug Description
|
|
description: A clear and concise description of what the bug is.
|
|
placeholder: Describe the bug...
|
|
validations:
|
|
required: true
|
|
|
|
- type: textarea
|
|
id: reproduction
|
|
attributes:
|
|
label: Steps to Reproduce
|
|
description: Steps to reproduce the behavior
|
|
placeholder: |
|
|
1. Navigate to '...'
|
|
2. Click on '...'
|
|
3. Make API call to '...'
|
|
4. See error
|
|
validations:
|
|
required: true
|
|
|
|
- type: textarea
|
|
id: expected
|
|
attributes:
|
|
label: Expected Behavior
|
|
description: What did you expect to happen?
|
|
placeholder: Describe what should happen...
|
|
validations:
|
|
required: true
|
|
|
|
- type: textarea
|
|
id: actual
|
|
attributes:
|
|
label: Actual Behavior
|
|
description: What actually happened?
|
|
placeholder: Describe what actually happened...
|
|
validations:
|
|
required: true
|
|
|
|
- type: textarea
|
|
id: logs
|
|
attributes:
|
|
label: Error Logs/Screenshots
|
|
description: If applicable, add error logs, stack traces, or screenshots
|
|
placeholder: Paste logs or drag and drop screenshots here...
|
|
validations:
|
|
required: false
|
|
|
|
- type: dropdown
|
|
id: environment
|
|
attributes:
|
|
label: Environment
|
|
description: Where are you running the application?
|
|
options:
|
|
- Local Development
|
|
- Docker
|
|
- Cloud Deployment
|
|
- Other
|
|
validations:
|
|
required: true
|
|
|
|
- type: input
|
|
id: python-version
|
|
attributes:
|
|
label: Python Version
|
|
description: What version of Python are you using?
|
|
placeholder: e.g., 3.9.0, 3.10.2, 3.11.5
|
|
validations:
|
|
required: false
|
|
|
|
- type: input
|
|
id: flask-version
|
|
attributes:
|
|
label: Flask Version
|
|
description: What version of Flask are you using?
|
|
placeholder: e.g., 2.2.5
|
|
validations:
|
|
required: false
|
|
|
|
- type: textarea
|
|
id: additional
|
|
attributes:
|
|
label: Additional Context
|
|
description: Add any other context about the problem here
|
|
placeholder: Any additional information...
|
|
validations:
|
|
required: false
|
|
|
|
- type: checkboxes
|
|
id: checklist
|
|
attributes:
|
|
label: Pre-submission Checklist
|
|
description: Please confirm the following
|
|
options:
|
|
- label: I have searched existing issues to ensure this bug hasn't been reported
|
|
required: true
|
|
- label: I have included all relevant information above
|
|
required: true
|
|
- label: I can reproduce this bug consistently
|
|
required: false
|