-
-
Notifications
You must be signed in to change notification settings - Fork 2.5k
GitHub: Improved issue templates #16354
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
Conversation
|
We used to have a longer template, but came to the realization that it's best to keep the form as simple as possible. If applicable, comments can be added to the description section. |
|
@Lamparter looking at the template, we can further optimize it by removing the requirements section. In most cases, the requirements can be inferred from the description and the steps to reproduce sections. |
|
@yaira2 do you like this? |
|
Do you mean the tips? |
Yes, as in using a blockquote. |
|
Yep |
|
We can try it. So in summary, these are the requested changes:
|
|
It might also be worth it to add a little section asking the user if they've updated Files and see if their issue is fixed on the latest version, like how it used to be in FluentHub. |
|
Most users tend to be on the latest version, so I think we're okay without that. |
Co-authored-by: 0x5BFA <[email protected]>
(many)
0x5bfa
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good to me.
Co-authored-by: Yair <[email protected]>
|
This PR should probably be renamed. |
Co-authored-by: Yair <[email protected]>
Co-authored-by: Yair <[email protected]>
Co-authored-by: Yair <[email protected]>
| required: false | ||
|
|
||
| # Note that the user should always upload the report rather than pasting it. | ||
| - type: markdown |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure if it's because of the wording, but the tip seems to have made things worse.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Maybe I should rethink it.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Perhaps it's the word pasting, should we try Please **upload** the log file by clicking "Attach files".?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think that's better probably, @0x5bfa what do you think?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't have preference
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It would be interesting to see if there's a bot that could automate this by detecting a log in text and wrapping it with a <details/> block.


Simple change, just added a remarks/comments section to the bug report template to make it match that of the feature/code quality issue templates. Might be useful if the user wants to add a remark such as what they think might be the problem, screenshots, etc. Also fixed a few minor issues in the YAML comments.