Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature: Further improve issue templates #2073

Merged
merged 10 commits into from
Feb 20, 2022
1 change: 0 additions & 1 deletion .editorconfig
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ root = true
# default configuration
[*]
charset = utf-8
end_of_line = crlf
trim_trailing_whitespace = true
insert_final_newline = true
indent_style = space
Expand Down
11 changes: 6 additions & 5 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,14 @@ body:
label: 🔎 Search Terms
description: >-
What search terms did you use when trying to find an existing bug report, looking in both open and closed issues?
List them here so people in the future can find this one more easily.
List them here (comma seperated) so people in the future can find this one more easily.
- 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 your
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:
Expand Down Expand Up @@ -62,11 +62,12 @@ body:
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
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.
render: yaml
If using a script please wrap with triple backticks and language. EG:
` ```javascript `
- type: textarea # Additional Information
attributes:
label: Additional information
Expand Down
3 changes: 3 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
blank_issues_enabled: false
contact_links:
- name: Have a formatting issue or feature request?
url: https://github.com/winstonjs/logform/issues/new/choose
about: Please search and report @ WinstonJS/Logform
- name: Need help using Winston?
url: https://stackoverflow.com/questions/tagged/winston
about: Please look on StackOverflow first to see if someone has already answered your question.
3 changes: 1 addition & 2 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ body:
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.
List them here (comma seperated) so people in the future can find this one more easily.
- type: textarea # Feature Definition
validations:
required: true
Expand All @@ -31,7 +31,6 @@ body:
label: Use case
description: |
If you desire you can provide use cases for the requested feature.
render: yaml
- type: textarea # Additional Information
attributes:
label: Additional information
Expand Down