Skip to content

Commit 8f0d487

Browse files
authored
Update issue templates (#2030)
* chore: update issue templates * chore: cleanup
1 parent 765b564 commit 8f0d487

File tree

4 files changed

+104
-63
lines changed

4 files changed

+104
-63
lines changed

.github/ISSUE_TEMPLATE.md

Lines changed: 0 additions & 63 deletions
This file was deleted.

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
name: Have you encountered an issue?
2+
description: Report an issue with Winston.
3+
title: "[Bug]: "
4+
labels: ["Bug", "Needs Investigation"]
5+
body:
6+
- type: markdown # Form Header
7+
attributes:
8+
value: >-
9+
This issue form is for reporting bugs only! Please help us reduce duplicate issues by searching through both
10+
open and closed issues though. It only takes 5 minutes and helps us with housekeeping. :)
11+
- type: textarea # Problem Definition
12+
validations:
13+
required: true
14+
attributes:
15+
label: The problem
16+
description: >-
17+
Please provide a clear and concise description of the problem you've encountered and what the your
18+
expected behavior was.
19+
- type: markdown # Environment Section Header
20+
attributes:
21+
value: |
22+
## Environment
23+
- type: input # Affected Version Input
24+
id: winston-version
25+
validations:
26+
required: true
27+
attributes:
28+
label: What version of Winston presents the issue?
29+
placeholder: v3.4.0
30+
description: >
31+
Can be found by running one of the following (depending on your package manager of choice):
32+
- `npm list winston`
33+
- `yarn list --pattern winston`
34+
- type: input # Affected Version Input
35+
id: node-version
36+
validations:
37+
required: true
38+
attributes:
39+
label: What version of Node are you using?
40+
placeholder: v16.8.0
41+
description: >
42+
Can be found by running the following: `node -v`
43+
- type: input # Last Known Working Version
44+
attributes:
45+
label: If this worked in a previous version of Winston, which was it?
46+
placeholder: v3.0.0
47+
description: >
48+
If known, otherwise please leave blank.
49+
- type: markdown # Details Section Header
50+
attributes:
51+
value: |
52+
# Details
53+
- type: textarea # Minimum Working Example Input
54+
attributes:
55+
label: Minimum Working Example
56+
description: |
57+
If you can, providing an MWE to reproduce the issue you're encountering can greatly speed up
58+
investigation into the issue by one of our maintainers, or anyone else in the community who's looking
59+
to get involved.
60+
61+
This can be as simple as a script, a link to a repo, etc.
62+
render: yaml
63+
- type: textarea # Additional Information
64+
attributes:
65+
label: Additional information
66+
description: >
67+
If you have any additional information for us that you feel will be valuable, please use the field below.

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Need help using Winston?
4+
url: https://stackoverflow.com/questions/tagged/winston
5+
about: Please look on StackOverflow first to see if someone has already answered your question.
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
name: Would you like to see a feature implemented?
2+
description: Request a new feature for Winston
3+
title: "[Feature Request]: "
4+
labels: ["Feature Request", "Needs Investigation"]
5+
body:
6+
- type: markdown # Form Header
7+
attributes:
8+
value: |
9+
This issue form is for requesting features only! Please help us reduce duplicate issues by searching through both
10+
open and closed issues though. It only takes 5 minutes and helps us with housekeeping. :)
11+
- type: textarea # Feature Definition
12+
validations:
13+
required: true
14+
attributes:
15+
label: The problem
16+
description: >-
17+
Please provide a clear and concise description of the feature you would like to see implemented.
18+
- type: markdown # Feature Details Section
19+
attributes:
20+
value: |
21+
# Details
22+
- type: textarea # Use Case Input
23+
attributes:
24+
label: Use case
25+
description: |
26+
If you desire you can provide use cases for the requested feature.
27+
render: yaml
28+
- type: textarea # Additional Information
29+
attributes:
30+
label: Additional information
31+
description: >
32+
If you have any additional information for us that you feel will be valuable, please use the field below.

0 commit comments

Comments
 (0)