-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Add issue templates #4316
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
Add issue templates #4316
Conversation
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.
Thanks for the PR! This does look very nice! It's cool that we can link out to the forum and chat.
As per recommendation in #4291 (comment), I'm giving my (edited) feedback here: In my opinion, to the error template, it would be great to add an optional "Expected behaviour" section. Some issues, like #4311, the expected behaviour is to do not trigger adjacent pins. (Duh!) This could be added to the "Addicional information", but it would probably be drowned out by other things, and possibly missed. |
Thanks! for the feedback @ismael-miguel. I expect the "Expected behavior" to be part of the Behavior section. Its not necessary to adhere to the format provided. The template just provides a minimal structure that can be further modified by the issue filler. |
Thank you for your insight @microdev1. Personally, I would assume that Behaviour is meant as Observed Behaviour, therefore the suggestion to add the Excepted Behaviour section, to keep the waters separated. But, in the end, I agree that the user can just ignore the template, despite being highly recommended to follow 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.
Looks great! I just suggest some changes to add clearer instructions.
@ajs256 Thanks! for the suggestions. I am not adding all of the tags as they cause the enclosed content to not show up in preview. |
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.
Great! Let's start with this. Thank you!
Bug Report
andFeature Request
.