Add Github issue template #268
Conversation
WalkthroughThe changes introduce a new issue template in the GitHub repository, specifically for reporting problems related to the Polestar API integration within Home Assistant. This template includes structured sections that guide users in providing detailed information about their issues, including descriptions of the problem, environment details, error logs, and additional information. The template also emphasizes the importance of retaining all provided text to ensure effective issue resolution. Changes
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 2
🧹 Outside diff range and nitpick comments (3)
.github/ISSUE_TEMPLATE.md (3)
1-5: Enhance the header instructions for better issue reportingConsider adding these important points to the header:
- Instructions to search existing issues before creating a new one
- A link to the latest release
- Guidelines about handling sensitive information (logs redaction)
<!-- READ THIS FIRST: - Always try the latest version before reporting a bug - your issue may already have been fixed. + - Search existing issues to avoid duplicates: https://github.com/jschlyter/ha-polestar/issues + - Latest release: https://github.com/jschlyter/ha-polestar/releases/latest - Provide as many details as possible. Paste logs, configuration samples and code into the backticks. + - Remove sensitive information (tokens, passwords, IDs) from your logs and configuration DO NOT DELETE ANY TEXT from this template! Otherwise, your issue may be closed without comment. -->
13-22: Add additional environment detailsConsider requesting more technical details that could be relevant for debugging.
- Polestar API release with the issue: - Home Assistant Core release: - Operating environment (OS/Container/Supervised/Core): +- Python version: +- Hardware platform (if relevant): +- Browser and version (if UI-related):
33-33: Expand the additional information sectionProvide more guidance about what kind of additional information could be helpful.
## Additional information +<!-- + Please include any additional context that might be relevant: + - Screenshots or videos demonstrating the issue + - Links to related issues or discussions + - Information about any troubleshooting steps already attempted + - Whether this is a regression (worked before) + - Frequency of the issue (constant/intermittent) +-->
| ## Traceback/Error logs | ||
| <!-- | ||
| If you come across any trace or error logs, please provide them. | ||
| --> | ||
|
|
||
| ```txt | ||
|
|
||
| ``` |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Enhance error logging instructions
Add more specific guidance about which logs to include and how to obtain them.
## Traceback/Error logs
<!--
If you come across any trace or error logs, please provide them.
+ Include:
+ 1. Home Assistant logs (Settings -> System -> Logs)
+ 2. Integration logs (enable debug logging in configuration.yaml)
+ 3. Browser console logs (if UI-related)
+
+ Use the code block below and ensure proper formatting
-->📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| ## Traceback/Error logs | |
| <!-- | |
| If you come across any trace or error logs, please provide them. | |
| --> | |
| ```txt | |
| ``` | |
| ## Traceback/Error logs | |
| <!-- | |
| If you come across any trace or error logs, please provide them. | |
| Include: | |
| 1. Home Assistant logs (Settings -> System -> Logs) | |
| 2. Integration logs (enable debug logging in configuration.yaml) | |
| 3. Browser console logs (if UI-related) | |
| Use the code block below and ensure proper formatting | |
| --> | |
| ## The problem | ||
| <!-- | ||
| Describe the issue you are experiencing here to communicate to the | ||
| maintainers. Tell us what you were trying to do and what happened. | ||
| --> | ||
|
|
There was a problem hiding this comment.
🛠️ Refactor suggestion
Structure the problem description section for better clarity
The problem description section would benefit from more specific prompts to help users provide complete information.
## The problem
<!--
Describe the issue you are experiencing here to communicate to the
maintainers. Tell us what you were trying to do and what happened.
+ Please provide:
+ 1. Expected behavior
+ 2. Actual behavior
+ 3. Clear steps to reproduce the issue
+ 4. Any relevant configuration (remember to remove sensitive data)
-->📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| ## The problem | |
| <!-- | |
| Describe the issue you are experiencing here to communicate to the | |
| maintainers. Tell us what you were trying to do and what happened. | |
| --> | |
| ## The problem | |
| <!-- | |
| Describe the issue you are experiencing here to communicate to the | |
| maintainers. Tell us what you were trying to do and what happened. | |
| Please provide: | |
| 1. Expected behavior | |
| 2. Actual behavior | |
| 3. Clear steps to reproduce the issue | |
| 4. Any relevant configuration (remember to remove sensitive data) | |
| --> | |
Summary by CodeRabbit