Skip to content

Latest commit

 

History

History
44 lines (27 loc) · 2.42 KB

HOW_TO_REPORT_BUG.md

File metadata and controls

44 lines (27 loc) · 2.42 KB

How to Report a Bug

If you encounter a bug while using the CatLINK v2 Custom Integration for Home Assistant, we want to hear about it! Reporting bugs helps us improve the integration and provide a better experience for everyone. Please follow the steps below to submit a bug report:

Steps to Report a Bug

  1. Update to the Latest Version:

    • Before reporting a bug, ensure you are using the latest version of the CatLINK integration. Sometimes, bugs are fixed in newer versions.

  2. Check for Existing Issues:

    • Search through the existing issues to see if your problem has already been reported. If you find a similar issue, you can add additional information as a comment.

  3. Gather Information:

    • Describe the Bug: Provide a clear and concise description of the bug. Include details about what you were trying to do, what you expected to happen, and what actually happened.
    • Home Assistant Logs: Check the Home Assistant logs for any error messages related to the integration. Copy the relevant log entries, as these are crucial for diagnosing the issue.
    • System Details: Note down details like your Home Assistant version, CatLINK integration version, and how you installed the integration (e.g., via HACS, manual installation).

  4. Submit a Bug Report:

    • Go to the issues page of this repository.
    • Click on the "New Issue" button.
    • Choose the "Bug Report" template to ensure you provide all the necessary details.
    • Fill out the form with the information you gathered. Be as detailed as possible to help us understand and reproduce the issue.
    • Submit the issue.

What Happens Next?

Once you've submitted your bug report, the maintainers will review it. We may ask for additional information or provide troubleshooting steps. We'll work to reproduce the issue and find a fix. You'll be notified through GitHub when updates are made to your bug report.

Thank You!

Your efforts in reporting bugs help us maintain a high-quality integration. We appreciate your contribution to making this project better!

Link to the Bug Report Template

You can include a direct link to the bug report template if your GitHub repository is public:

[Submit a Bug Report](https://github.com/hasscc/catlink/issues/new?assignees=&labels=bug%2Ctriage&template=bug_report.yml&title=%5BBug%5D%3A+)