Skip to content

Commit e1cc92c

Browse files
committed
chore: update issue templates
Add `type: Bug` to bug_report.md and `type: Feature` to issue-template.md, and convert the visible guidance text into HTML comments so placeholder instructions don't render in the created issue. Signed-off-by: Alex Piatakov <alex.piatakov@swirldslabs.com>
1 parent 143a4e4 commit e1cc92c

2 files changed

Lines changed: 11 additions & 8 deletions

File tree

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,21 +4,23 @@ about: Create a report to help us improve
44
title: ''
55
labels: ''
66
assignees: ''
7+
type: Bug
78

89
---
910

1011
### Problem description
11-
A clear and concise description of what the bug is.
12+
<!-- A clear and concise description of what the bug is. -->
1213

1314
### Step to reproduce
14-
Steps to reproduce the behavior:
15+
<!-- Steps to reproduce the behavior:
1516
1. Go to '...'
1617
2. Click on '....'
1718
3. Scroll down to '....'
1819
4. See error
20+
-->
1921

2022
### Expected behavior
21-
A clear and concise description of what you expected to happen.
23+
<!-- A clear and concise description of what you expected to happen. -->
2224

2325
### Screenshots
24-
If applicable, add screenshots to help explain your problem.
26+
<!-- If applicable, add screenshots to help explain your problem. -->

.github/ISSUE_TEMPLATE/issue-template.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,18 @@ about: To record product requirements in the form ready for developers to pick u
44
title: ''
55
labels: ''
66
assignees: ''
7+
type: Feature
78

89
---
910

1011
### Problem description
11-
Describe the current state of affairs and why it needs to change.
12+
<!-- Describe the current state of affairs and why it needs to change. -->
1213

1314
### Requirements
14-
Exact requirement for the product - what needs to be done?
15+
<!-- Exact requirement for the product - what needs to be done? -->
1516

1617
### Definition of done
17-
How do we know we've fully dealt with it?
18+
<!-- How do we know we've fully dealt with it? -->
1819

1920
### Acceptance criteria
20-
What are the criteria by which we determine if the issue has been resolved?
21+
<!-- What are the criteria by which we determine if the issue has been resolved? -->

0 commit comments

Comments
 (0)