Add GitHub issue templates for bug reports and feature requests
- 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
This commit is contained in:
127
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
Normal file
127
.github/ISSUE_TEMPLATE/bug_report.yml
vendored
Normal file
@@ -0,0 +1,127 @@
|
||||
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
|
||||
155
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
Normal file
155
.github/ISSUE_TEMPLATE/feature_request.yml
vendored
Normal file
@@ -0,0 +1,155 @@
|
||||
name: Feature Request
|
||||
description: Suggest a new feature or enhancement for the Flask AR API Demo Server
|
||||
title: "[Feature]: "
|
||||
labels: ["enhancement"]
|
||||
body:
|
||||
- type: markdown
|
||||
attributes:
|
||||
value: |
|
||||
Thanks for suggesting a new feature! Please provide as much detail as possible to help us understand your request.
|
||||
|
||||
- type: dropdown
|
||||
id: component
|
||||
attributes:
|
||||
label: Component
|
||||
description: Which component would this feature affect?
|
||||
options:
|
||||
- API Endpoints
|
||||
- Admin Interface
|
||||
- Barcode Generation
|
||||
- Image Management
|
||||
- Authentication/Authorization
|
||||
- Database/Models
|
||||
- Product Management
|
||||
- Tenant Management
|
||||
- Documentation
|
||||
- Other
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: dropdown
|
||||
id: feature-type
|
||||
attributes:
|
||||
label: Feature Type
|
||||
description: What type of feature is this?
|
||||
options:
|
||||
- New Functionality
|
||||
- Enhancement to Existing Feature
|
||||
- UI/UX Improvement
|
||||
- Performance Improvement
|
||||
- Developer Experience
|
||||
- Documentation
|
||||
- Testing
|
||||
- Security
|
||||
- Other
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: problem
|
||||
attributes:
|
||||
label: Problem Statement
|
||||
description: Is your feature request related to a problem? Please describe.
|
||||
placeholder: I'm frustrated when... / There's no way to... / It would be helpful if...
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: solution
|
||||
attributes:
|
||||
label: Proposed Solution
|
||||
description: Describe the solution you'd like to see
|
||||
placeholder: I would like to be able to... / The system should... / Add a new endpoint that...
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: alternatives
|
||||
attributes:
|
||||
label: Alternatives Considered
|
||||
description: Have you considered any alternative solutions or workarounds?
|
||||
placeholder: I've thought about... / Another approach could be... / Currently using...
|
||||
validations:
|
||||
required: false
|
||||
|
||||
- type: textarea
|
||||
id: use-case
|
||||
attributes:
|
||||
label: Use Case
|
||||
description: Describe your use case and how this feature would benefit you or others
|
||||
placeholder: |
|
||||
This feature would allow me to...
|
||||
It would be useful for...
|
||||
The expected workflow would be...
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: implementation
|
||||
attributes:
|
||||
label: Implementation Ideas
|
||||
description: If you have ideas about how to implement this feature, please share them
|
||||
placeholder: |
|
||||
This could be implemented by...
|
||||
Possible technical approach...
|
||||
Required changes...
|
||||
validations:
|
||||
required: false
|
||||
|
||||
- type: dropdown
|
||||
id: priority
|
||||
attributes:
|
||||
label: Priority
|
||||
description: How important is this feature to you?
|
||||
options:
|
||||
- Nice to have
|
||||
- Would be useful
|
||||
- Important
|
||||
- Critical
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: dropdown
|
||||
id: breaking
|
||||
attributes:
|
||||
label: Breaking Change
|
||||
description: Would this feature require breaking changes to the API or existing functionality?
|
||||
options:
|
||||
- "No"
|
||||
- "Yes"
|
||||
- "Unsure"
|
||||
validations:
|
||||
required: true
|
||||
|
||||
- type: textarea
|
||||
id: mockups
|
||||
attributes:
|
||||
label: Mockups/Examples
|
||||
description: If applicable, add mockups, screenshots, or examples from other systems
|
||||
placeholder: Drag and drop images or paste links here...
|
||||
validations:
|
||||
required: false
|
||||
|
||||
- type: textarea
|
||||
id: additional
|
||||
attributes:
|
||||
label: Additional Context
|
||||
description: Add any other context, links, or references about the feature request
|
||||
placeholder: Related to... / Similar to... / Reference documentation...
|
||||
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 feature hasn't been requested
|
||||
required: true
|
||||
- label: I have clearly described the feature and its benefits
|
||||
required: true
|
||||
- label: I am willing to help test this feature if implemented
|
||||
required: false
|
||||
- label: I am willing to contribute to the implementation
|
||||
required: false
|
||||
Reference in New Issue
Block a user