Skip to content

Commit e7f8341

Browse files
author
Drew Yang
committed
feat: 💡 improve issue template with labeling | adding improvement request template
1 parent b9fa9dd commit e7f8341

File tree

3 files changed

+51
-5
lines changed

3 files changed

+51
-5
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
22
name: Bug report
33
about: Create a report to help us improve
4-
title: ''
5-
labels: 'bug'
4+
title: "Bug: "
5+
labels: ["bug", "triage"]
66
assignees: ''
77

88
---

‎.github/ISSUE_TEMPLATE/feature_request.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
---
22
name: Feature request
33
about: Suggest an idea for a new feature
4-
title: ''
5-
labels: 'enhancement, awaiting-triage'
4+
title: "FEAT: "
5+
labels: ["enhancement", "triage"]
66
assignees: ''
77

88
---
99

1010
## Feature Request
1111

1212
### Problem
13-
A clear and concise description how this idea has manifested and the context. Elaborate on the need for this feature and/or what could be improved. Ex. I'm always frustrated when [...]
13+
A clear and concise description how this idea has manifested and the context. Elaborate on the need for this feature. Ex. I'm always frustrated when [...]
1414

1515
### Requirements
1616
A clear and concise description of the requirements to satisfy the new feature. Detail what you expect from a successful implementation of the feature. Ex. When using this feature, it should [...]
Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
name: Improvement request
3+
about: Suggest an idea for improvement
4+
title: "IMPR: "
5+
labels: ["enhancement", "triage"]
6+
assignees: ''
7+
8+
---
9+
10+
## Improvement Request
11+
12+
### Problem
13+
A clear and concise description how this idea has manifested and the context. Elaborate on the need for what could be improved. Ex. I'm always frustrated when [...]
14+
15+
### Requirements
16+
A clear and concise description of the requirements to satisfy the new improvement. Detail what you expect from a successful implementation of the improvement. Ex. When using this improvement, it should [...]
17+
18+
### Justification
19+
Provide the key benefits in making this a supported improvement. Ex. Adding support for this improvement would ensure [...]
20+
21+
### Alternative Considerations
22+
Do you currently have a work-around for this? Provide any alternative solutions or improvements you've considered.
23+
24+
### Related Errors
25+
Add any errors as a direct result of not exposing this improvement.
26+
27+
Please include steps to reproduce provided errors as follows:
28+
- OS (WIN | MACOS | Linux)
29+
- Python Version OR MATLAB Version
30+
- MySQL Version
31+
- MySQL Deployment Strategy (local-native | local-docker | remote)
32+
- DataJoint Version
33+
- Minimum number of steps to reliably reproduce the issue
34+
- Complete error stack as a result of evaluating the above steps
35+
36+
### Screenshots
37+
If applicable, add screenshots to help explain your improvement.
38+
39+
### Additional Research and Context
40+
Add any additional research or context that was conducted in creating this improvement request.
41+
42+
For example:
43+
- Related GitHub issues and PR's either within this repository or in other relevant repositories.
44+
- Specific links to specific line or focus within source code.
45+
- Relevant summary of Maintainers development meetings, milestones, projects, etc.
46+
- Any additional supplemental web references or links that would further justify this improvement request.

0 commit comments

Comments
 (0)