Skip to content

Commit 3994d7c

Browse files
authored
feat(docs) Update issue templates (#3)
feat(docs) Update issue templates (#3) --- ### Description - Introduce issue template
1 parent fc75a84 commit 3994d7c

4 files changed

Lines changed: 22 additions & 43 deletions

File tree

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
---
22
name: Bug Report
33
about: Create a report to help us improve
4-
title: '[BUG] '
5-
labels: 'bug'
4+
title: "[BUG] "
5+
labels: bug
66
assignees: ''
7+
78
---
89

910
## Bug Description

.github/ISSUE_TEMPLATE/custom.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
name: Custom issue template
3+
about: Describe this issue template's purpose here.
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+

.github/ISSUE_TEMPLATE/documentation.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
---
22
name: Documentation Improvement
33
about: Suggest improvements or report issues with documentation
4-
title: '[DOCS] '
5-
labels: 'documentation'
4+
title: "[DOCS] "
5+
labels: documentation
66
assignees: ''
7+
78
---
89

910
## Documentation Location
Lines changed: 6 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,53 +1,20 @@
11
---
2-
name: Feature Request
2+
name: Feature request
33
about: Suggest an idea for this project
4-
title: '[FEATURE] '
5-
labels: 'enhancement'
4+
title: ''
5+
labels: ''
66
assignees: ''
7-
---
8-
9-
## Feature Summary
10-
11-
A clear and concise description of the feature you'd like to request.
127

13-
## Problem / Motivation
8+
---
149

1510
**Is your feature request related to a problem? Please describe.**
16-
1711
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
1812

19-
## Proposed Solution
20-
2113
**Describe the solution you'd like**
22-
2314
A clear and concise description of what you want to happen.
2415

25-
## Alternative Solutions
26-
2716
**Describe alternatives you've considered**
28-
2917
A clear and concise description of any alternative solutions or features you've considered.
3018

31-
## Use Cases
32-
33-
Describe specific use cases where this feature would be beneficial:
34-
35-
1. Use case 1
36-
2. Use case 2
37-
3. Use case 3
38-
39-
## Example API / Usage
40-
41-
```python
42-
# If applicable, provide an example of how the feature might be used
43-
```
44-
45-
## Additional Context
46-
47-
Add any other context, screenshots, or mockups about the feature request here.
48-
49-
## Checklist
50-
51-
- [ ] I have searched existing issues/discussions to ensure this is not a duplicate
52-
- [ ] I have provided clear use cases for this feature
53-
- [ ] I am willing to help implement this feature (optional)
19+
**Additional context**
20+
Add any other context or screenshots about the feature request here.

0 commit comments

Comments
 (0)