Skip to content

Commit 87d9cc4

Browse files
Merge pull request #472 from oss-slu/471-use-markdown-headers-and-add-issue-types-to-issue-templates
Update issue template formatting and set issue type
2 parents f11f9bd + d622599 commit 87d9cc4

2 files changed

Lines changed: 24 additions & 10 deletions

File tree

.github/ISSUE_TEMPLATE/new-feature-request.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,19 +2,25 @@
22
name: New Feature request
33
about: Suggest an idea or feature for this project
44
labels: enhancement
5+
type: Feature
56
---
67

7-
**You would like to implement a new component? If yes, please provide all the necessary details** \
8+
## You would like to implement a new component? If yes, please provide all the necessary details
9+
810
A clear configuration of the component and its working principle. Ex. It uses PWM
11+
912
- GPIO pins that are used by this component.
1013
- Circuit diagram if available
1114
- Any additional chips are used. Ex: It uses ADC0834
1215

13-
**Is your feature request related to a problem? Please describe.** \
16+
## Is your feature request related to a problem? Please describe.
17+
1418
A clear and concise description of what the problem is. Ex: I have a problem with LED [...]
1519

16-
**Describe the solution you'd like** \
20+
## Describe the solution you'd like
21+
1722
A clear and concise description of what you want to happen.
1823

19-
**Additional context** \
24+
## Additional context
25+
2026
Add any other context or screenshots about the feature request here.

.github/ISSUE_TEMPLATE/report-a-bug.md

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,27 +2,35 @@
22
name: Report a Bug
33
about: Create a report to help us improve
44
labels: bug
5+
type: Bug
56
---
67

7-
**Describe the bug** \
8+
## Describe the bug
9+
810
A clear and concise description of what the bug is.
911

10-
**What component are you facing this issue with?** \
12+
## What component are you facing this issue with?
13+
1114
The component details and what functionality causes this issue
1215

13-
**To Reproduce** \
16+
## To Reproduce
17+
1418
Steps to reproduce the behavior: For example
19+
1520
1. Go to '...'
1621
2. Click on '....'
1722
3. Scroll down to '....'
1823
4. Run the component '....'
1924
5. See error
2025

21-
**Expected behavior** \
26+
## Expected behavior
27+
2228
A clear and concise description of what you expected to happen.
2329

24-
**Screenshots** \
30+
## Screenshots
31+
2532
If applicable, add screenshots to help explain your problem.
2633

27-
**Additional context** \
34+
## Additional context
35+
2836
Add any other context about the problem here.

0 commit comments

Comments
 (0)