Skip to content

Commit e5c418f

Browse files
authored
chore: update issue templates in new format
1 parent 9132ee4 commit e5c418f

File tree

4 files changed

+44
-19
lines changed

4 files changed

+44
-19
lines changed

.github/ISSUE_TEMPLATE/bug-report.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
name: Bug Report
33
about: Report an issue
44
title: ''
5-
labels: type: fix, status: awaiting-triage, bug: unconfirmed
5+
labels: 'bug: unconfirmed, status: awaiting-triage, type: fix'
66
assignees: ''
77

88
---
@@ -26,9 +26,9 @@ alternatively add your console logs here. -->
2626

2727
## Environment
2828

29-
<!-- This is just your OS and environment information [e.g. Ubuntu 18.04 LTS,
30-
Node v14.14.0] -->
29+
<!-- Your OS and environment information [e.g. Ubuntu 18.04 LTS,
30+
Python 3.10] -->
3131

32-
### Additional context
32+
## Additional context
3333

3434
<!-- Add any other context about the problem here. -->
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
name: False Positive Report
3+
about: Report a false positive from proselint
4+
title: False positive for [CHECK]
5+
labels: 'bug: unconfirmed, cat: false-positive, priority: high, status: awaiting-triage,
6+
type: fix'
7+
assignees: ''
8+
9+
---
10+
11+
## Description
12+
13+
<!-- A clear and concise description, including the check that flagged the input, the input, and why you believe this result to be incorrect. -->
14+
15+
## Expected Behavior
16+
17+
<!-- A clear and concise description of what you expected to happen. -->
18+
19+
## Environment
20+
21+
<!-- Your OS and environment information [e.g. Ubuntu 18.04 LTS,
22+
Python 3.10]. -->
23+
24+
## Additional context
25+
26+
<!-- Add any other context here, including any sources you'd like to reference about the matter. -->
Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,28 @@
11
---
22
name: Feature Request
3-
about: Make a suggestion on a feature or improvement for the project
4-
title: ''
5-
labels: type: feat, status: awaiting-triage
3+
about: Suggest a feature or improvement
4+
title: 'feat: [FEATURE]'
5+
labels: 'status: awaiting-triage, type: feat'
66
assignees: ''
77

88
---
99

10-
## This would solve...
10+
## Problem space
1111

1212
<!-- A clear and concise description of the problem this feature request relates
1313
to, if applicable. -->
1414

15-
## The implementation should look like...
15+
## Implementation
1616

1717
<!-- A clear and concise description of how you expect this to be resolved or
1818
implemented. -->
1919

20-
## I have also considered...
20+
## Considerations
2121

2222
<!-- A clear and concise description of any alternative solutions or features
23-
you have considered. -->
23+
you have considered, if applicable. -->
2424

2525
## Additional context
2626

27-
<!-- Add any other context, screenshots or ideas about the feature request
27+
<!-- Add any other context, screenshots, ideas, or prior art related to the feature request
2828
here. -->

.github/ISSUE_TEMPLATE/rule-request.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,21 @@
11
---
22
name: Rule Request
3-
about: Make a suggestion on a new rule or check for proselint
3+
about: Suggest a new check
44
title: ''
5-
labels: type: feat, cat: new-rule, status: awaiting-triage
5+
labels: 'cat: new-rule, status: awaiting-triage, type: feat'
66
assignees: ''
77

88
---
99

10-
## This would solve...
10+
## Topic
1111

12-
<!-- A clear and concise description of the linguistic problem this resolves
13-
and relates to. -->
12+
<!-- A clear and concise description of the linguistic matter this resolves or relates to. -->
1413

15-
## And this should flag...
14+
## Things to detect
1615

1716
<!-- A few examples of things this rule should detect. -->
1817

19-
## But it should not flag...
18+
## Things to avoid
2019

2120
<!-- A few examples of things that are similar to this rule's targeted forms
2221
but that it should not detect (i.e. potential false positives), if any. -->

0 commit comments

Comments
 (0)