-
Notifications
You must be signed in to change notification settings - Fork 97
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: implement issue templates (#149)
- Loading branch information
1 parent
c9b80e5
commit e50a975
Showing
3 changed files
with
118 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,75 @@ | ||
name: Have you encountered an issue? | ||
description: Report an issue with a Logform formatter. | ||
title: "[Bug]: " | ||
labels: ["Bug", "Needs Investigation"] | ||
body: | ||
- type: markdown # Form Header | ||
attributes: | ||
value: >- | ||
This issue form is for reporting bugs only! | ||
- type: textarea # Problem Definition | ||
validations: | ||
required: true | ||
attributes: | ||
label: The problem | ||
description: >- | ||
Please provide a clear and concise description of the problem you've encountered and what the | ||
expected behavior was. | ||
- type: markdown # Environment Section Header | ||
attributes: | ||
value: | | ||
## Environment | ||
- type: input # Affected Version Input | ||
id: logform-version | ||
validations: | ||
required: true | ||
attributes: | ||
label: What version of Logform presents the issue? | ||
placeholder: v2.4.0 | ||
description: > | ||
Can be found by running one of the following (depending on your package manager of choice): | ||
- `npm list logform` | ||
- `yarn list --pattern logform` | ||
- type: input # Affected Version Input | ||
id: node-version | ||
validations: | ||
required: true | ||
attributes: | ||
label: What version of Node are you using? | ||
placeholder: v16.8.0 | ||
description: > | ||
Can be found by running the following: `node -v` | ||
- type: input # Last Known Working Version | ||
attributes: | ||
label: If this worked in a previous version of Logform, which was it? | ||
placeholder: v2.0.0 | ||
description: > | ||
If known, otherwise please leave blank. | ||
- type: markdown # Details Section Header | ||
attributes: | ||
value: | | ||
# Details | ||
- type: textarea # Minimum Working Example Input | ||
attributes: | ||
label: Minimum Working Example | ||
description: | | ||
If you can, providing an MWE to reproduce the issue you're encountering can greatly speed up | ||
investigation into the issue by one of our maintainers, or anyone else in the community who's looking | ||
to get involved. | ||
This can be as simple as a script, a link to a repo, etc. | ||
If using a script please wrap with triple backticks and language. EG: | ||
` ```javascript ` | ||
- type: textarea # Additional Information | ||
attributes: | ||
label: Additional information | ||
description: > | ||
If you have any additional information for us that you feel will be valuable, please use the field below. | ||
- type: input # Search Terms | ||
validations: | ||
required: true | ||
attributes: | ||
label: 🔎 Search Terms | ||
description: >- | ||
What search terms did you use when trying to find an existing feature request, looking in both open and closed issues? | ||
List them here so people in the future can find this one more easily. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,5 @@ | ||
blank_issues_enabled: false | ||
contact_links: | ||
- name: Need help using Logform Formats? | ||
url: https://stackoverflow.com/questions/tagged/winston | ||
about: Please look on StackOverflow first to see if someone has already answered your question. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
name: Would you like to see a feature implemented? | ||
description: Request a new feature for Logform | ||
title: "[Feature Request]: " | ||
labels: ["Feature Request", "Needs Investigation"] | ||
body: | ||
- type: markdown # Form Header | ||
attributes: | ||
value: | | ||
This issue form is for requesting features only! | ||
- type: textarea # Feature Definition | ||
validations: | ||
required: true | ||
attributes: | ||
label: The vision | ||
description: >- | ||
Please provide a clear and concise description of the feature you would like to see implemented. | ||
- type: markdown # Feature Details Section | ||
attributes: | ||
value: | | ||
# Details | ||
- type: textarea # Use Case Input | ||
attributes: | ||
label: Use case | ||
description: | | ||
If you desire you can provide use cases for the requested feature. | ||
- type: textarea # Additional Information | ||
attributes: | ||
label: Additional information | ||
description: > | ||
If you have any additional information for us that you feel will be valuable, please use the field below. | ||
- type: input # Search Terms | ||
validations: | ||
required: true | ||
attributes: | ||
label: 🔎 Search Terms | ||
description: >- | ||
What search terms did you use when trying to find an existing feature request, looking in both open and closed issues? | ||
List them here so people in the future can find this one more easily. |