Skip to content

[RFC] Update issue template#12989

Merged
fabaff merged 3 commits intohome-assistant:devfrom
amelchio:issue-template
Mar 26, 2018
Merged

[RFC] Update issue template#12989
fabaff merged 3 commits intohome-assistant:devfrom
amelchio:issue-template

Conversation

@amelchio
Copy link
Copy Markdown
Contributor

@amelchio amelchio commented Mar 8, 2018

Description:

While cleaning up several platforms, I have gone through a lot of issues. This PR updates the issue template with my experience from that activity:

  • It is not always clear whether the issue is new. Thus I have added "last working release".
  • Python release rarely matters.
  • The operating system can matter but people won't think it's worth mentioning that they are on Windows.
  • The expectation usually is that things work.
  • The configuration can tell developers a lot but it is often left out.
  • Miscellaneous cleanups.

@homeassistant homeassistant added small-pr PRs with less than 30 lines. cla-signed labels Mar 8, 2018
@c727
Copy link
Copy Markdown

c727 commented Mar 8, 2018

  • 0.65 drops python 3.4 support and you removed that important part here
  • I don't think we need 2 PRs that have the same goal, as you have merge power feel free to close 1 PR

@tringler
Copy link
Copy Markdown
Contributor

What about a part to instruct how to setup the logging to debug and post the logs?
Just like:

logger:
   default: error
   logs:
     homeassistant.components._platform_: debug



**Problem-relevant `configuration.yaml` entries and steps to reproduce:**
**Related `configuration.yaml` entries (fill out even if it seems unimportant):**
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What about a link if they have public config?

@amelchio
Copy link
Copy Markdown
Contributor Author

We can certainly add all kinds of questions, instructions and alternatives to the template.

In my opinion, though, it should be short and relevant so submitters do not get annoyed halfway through and skip important parts.

A documentation page on reporting bugs might be an idea. It could go into much more detail and the user would be in a frame of mind where he was willing to digest the information.

@fabaff
Copy link
Copy Markdown
Member

fabaff commented Mar 26, 2018

Details are now available in the documentation as well -> #5025

@amelchio
Copy link
Copy Markdown
Contributor Author

I removed a single word because we do not need to know the "first broken" release when we also ask for the "last working" release.

Copy link
Copy Markdown
Member

@fabaff fabaff left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks 🐦

@fabaff fabaff merged commit 3e6f4d0 into home-assistant:dev Mar 26, 2018
@balloob balloob mentioned this pull request Apr 13, 2018
@home-assistant home-assistant locked and limited conversation to collaborators Jul 26, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

cla-signed small-pr PRs with less than 30 lines.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants