Feature: Further improve issue templates#2073
Feature: Further improve issue templates#2073maverick1872 merged 10 commits intowinstonjs:masterfrom
Conversation
| label: Additional information | ||
| description: > | ||
| If you have any additional information for us that you feel will be valuable, please use the field below. | ||
| name: Have you encountered an issue? |
There was a problem hiding this comment.
Not sure why the diffs are against the entire file. This may have to due with the .editorconfig configuration for linebreaks? Will have to inspect these files to see if line-endings changed or not. In the meantime this can be more easily reviewed by enabling the hide whitespace option for the diff itself.
There was a problem hiding this comment.
Verified that line-endings were changed from previous. This is almost guaranteed to be because of the editor config. As such I'm removing that configuration and will let systems/git handle however it sees fit.
| attributes: | ||
| value: >- | ||
| This issue form is for reporting bugs only! | ||
| - type: input # Search Terms |
There was a problem hiding this comment.
Copying comment from winstonjs/logform#149:
The reason search terms came first is to encourage folks to do the search first, before doing all the work to write out a report. If they find a duplicate, they're likely to just comment on that instead of submitting again anyway.
There was a problem hiding this comment.
This is a fair criticism. Whatever resolution is determined I'll re-implement over on logform. Maybe put it second. That way viewers of issues get the most relevant information first but issue creators see it in such a manner that they immediately know they need to fill it out? In the meantime I'll do some further reading on these issue templates to see if there's more configuration available from the resultant template.
There was a problem hiding this comment.
@wbt reverted this change. It's such a minor thing that it's not worth changing until the issue templates offer more flexibility in how the resultant issue is formatted IMO.
DABH
left a comment
DABH
left a comment
There was a problem hiding this comment.
LGTM with the latest update. Thank you for this!
wbt
left a comment
wbt
left a comment
There was a problem hiding this comment.
I don't see any problem with rendering search terms first & wouldn't bother trying to figure out how to change display order, but that's just my perspective.
3 participants
This change-set moves the "Search Terms" input to the bottom of the issue. This means that it won't be the top-most section in the reported issues & feature requests.Subsequently it adds a link to submit issues/feature requests against WinstonJS/Logform. This URL will direct to the "choose issue type" page when issue templates are implemented on Logform. Until that point it'll just direct to the blank issue form.