Skip to content
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.

Sign up for GitHub

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 Github issue template #268

Merged
merged 1 commit into from
Dec 12, 2024
Merged

Add Github issue template #268

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions .github/ISSUE_TEMPLATE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
<!-- READ THIS FIRST:
- Always try the latest version before reporting a bug - your issue may already have been fixed.
- Provide as many details as possible. Paste logs, configuration samples and code into the backticks.
DO NOT DELETE ANY TEXT from this template! Otherwise, your issue may be closed without comment.
-->
## 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.
-->

Comment on lines +6 to +11
Copy link
Contributor

Choose a reason for hiding this comment

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

🛠️ 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.

Suggested change
## 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)
-->


## Environment
<!--
Provide details about the versions you are using, which helps us to reproduce
and find the issue quicker. Version information is found in the
Home Assistant frontend: Settings -> About and in `/config/integrations/integration/polestar_api`.
-->

- Polestar API release with the issue:
- Home Assistant Core release:
- Operating environment (OS/Container/Supervised/Core):

## Traceback/Error logs
<!--
If you come across any trace or error logs, please provide them.
-->

```txt

```
Comment on lines +24 to +31
Copy link
Contributor

Choose a reason for hiding this comment

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

🛠️ 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.

Suggested change
## 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
-->


## Additional information
Loading