Add Issue Templates (#133)
# Description * Add an issue template for bug reports * Add an issue template for feature requests
This commit is contained in:
parent
65a3b74fea
commit
2e9ac89e94
2 changed files with 60 additions and 0 deletions
34
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
34
.github/ISSUE_TEMPLATE/bug_report.md
vendored
Normal file
|
|
@ -0,0 +1,34 @@
|
|||
---
|
||||
name: Bug report
|
||||
about: Create a bug report
|
||||
title: "[Bug] "
|
||||
labels: type: bug
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
**Describe the Bug**
|
||||
Provide a clear and concise description of what the bug is.
|
||||
|
||||
**How to Reproduce**
|
||||
Steps to reproduce the bug:
|
||||
1. Configure the environment or settings with...
|
||||
2. Run the command...
|
||||
3. Observe the error or unexpected output at...
|
||||
4. Log output/error message
|
||||
|
||||
**Expected Behavior**
|
||||
A clear and concise description of what you expected to happen.
|
||||
|
||||
**Screenshots**
|
||||
If applicable, add screenshots to help explain the issue you are experiencing.
|
||||
|
||||
**Environment (please complete the following information):**
|
||||
- OS: [e.g. macOS, Linux, Windows]
|
||||
- Version/commit of Arcade AI: [e.g. 0.1.0, or the commit hash]
|
||||
|
||||
**Logs**
|
||||
If applicable, include detailed logs to help understand the problem.
|
||||
|
||||
**Additional Context**
|
||||
Add any other context about the problem here
|
||||
26
.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal file
26
.github/ISSUE_TEMPLATE/feature_request.md
vendored
Normal file
|
|
@ -0,0 +1,26 @@
|
|||
---
|
||||
name: Feature request
|
||||
about: Feature suggestion or idea
|
||||
title: "[Feature] "
|
||||
labels: type: feature
|
||||
assignees: ''
|
||||
|
||||
---
|
||||
|
||||
**Description**
|
||||
What is the point of the feature you would like to see implemented? Who/what will benefit from it?
|
||||
|
||||
**Proposed Feature**
|
||||
Provide a clear and concise description of the feature you would like implemented.
|
||||
|
||||
**Alternatives Considered**
|
||||
Discuss any alternative solutions or features you've considered. Why were these alternatives not suitable?
|
||||
|
||||
**Implementation Strategy**
|
||||
If you have ideas on how the feature could be implemented, share them here. This could include technical details, screenshots, mockups, etc.
|
||||
|
||||
**Use Case**
|
||||
Explain how this feature would be used and what benefits it would bring. Include specific examples to illustrate how this would improve functionality or user experience.
|
||||
|
||||
**Additional Context**
|
||||
Add any other context that would help the reader understand the feature request.
|
||||
Loading…
Reference in a new issue