Skip to content

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

Merged
merged 3 commits into from
Mar 4, 2021
Merged

Add issue templates #4316

merged 3 commits into from
Mar 4, 2021

Conversation

microdev1
Copy link
Collaborator

  • Adds templates for Bug Report and Feature Request.
  • Also adds links to forum and discord server.

issue_page_ui

@microdev1 microdev1 linked an issue Mar 3, 2021 that may be closed by this pull request
@microdev1 microdev1 mentioned this pull request Mar 3, 2021
Copy link
Member

@tannewt tannewt left a 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.

@ismael-miguel
Copy link

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!)
Others, like my issue #4279, the expected behaviour is that it should throw an exception because the filesystem is readonly.
Others, like #4300, could be that the frequency should be different or something else.

This could be added to the "Addicional information", but it would probably be drowned out by other things, and possibly missed.

@microdev1
Copy link
Collaborator Author

it would be great to add an optional "Expected behavior" section.

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.

@microdev1 microdev1 requested a review from tannewt March 3, 2021 17:21
@ismael-miguel
Copy link

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.

Copy link

@ajsirota ajsirota left a 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.

@microdev1
Copy link
Collaborator Author

@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.

Copy link
Member

@tannewt tannewt left a 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!

@tannewt tannewt merged commit 7970c88 into adafruit:main Mar 4, 2021
@microdev1 microdev1 deleted the issue-template branch March 5, 2021 06:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Template for issues
4 participants