Ver Fonte

docs: add a Support & Scope section and link it from both issue templates

This project was built for the author's own inverter (Sumry 3600) and
shared as-is. Make that explicit rather than implicit: bug fixes are
best-effort, there's no support commitment for hardware the author
doesn't own, and forking to adapt the code is an encouraged, legitimate
path rather than a fallback. Linked from both issue templates so it's
visible before someone files a report, not just buried in the README.
Conexo-Casa há 1 mês atrás
pai
commit
83eb5cae19

+ 10 - 0
.github/ISSUE_TEMPLATE/bug_report.yml

@@ -8,6 +8,16 @@ body:
         Thanks for reporting! Please fill in as much detail as possible.
         **Redact your IOT-Token** — keep only the first and last 4 characters.
 
+        **Before you file:** this integration is built and maintained for the
+        author's own inverter (a Sumry 3600), shared as-is — not a supported
+        product for every Siseli-connected device. See [Support &
+        Scope](https://github.com/Conexo-Casa/solar-of-things-ha#support--scope)
+        in the README. The detail you provide below (exact field names, a raw
+        API capture, your inverter/dongle model) is what actually gets bugs
+        fixed for hardware the author doesn't own — a report without it is
+        much less likely to go anywhere. Forking and patching it yourself is
+        always an option too.
+
   - type: input
     id: ha_version
     attributes:

+ 6 - 0
.github/ISSUE_TEMPLATE/feature_request.yml

@@ -7,6 +7,12 @@ body:
       value: |
         Thanks for the suggestion! Please describe the feature clearly.
 
+        This integration is maintained for the author's own hardware on a
+        best-effort basis — see [Support &
+        Scope](https://github.com/Conexo-Casa/solar-of-things-ha#support--scope)
+        in the README. Feature requests for devices the author doesn't own are
+        welcome, but a pull request gets there faster than a request alone.
+
   - type: textarea
     id: problem
     attributes:

+ 43 - 0
README.md

@@ -20,11 +20,20 @@
   Real-time power data · Battery management · Grid control · Energy Dashboard ready
 </p>
 
+> [!IMPORTANT]
+> **Support scope.** This integration was built and is maintained for the author's
+> own hardware (a Sumry 3600 inverter). It's shared publicly so others with
+> compatible or similar Siseli-connected devices can use and adapt it — not as a
+> commitment to support every inverter model or WiFi dongle variant sold under the
+> Siseli platform. See [Support & Scope](#support--scope) below before opening an
+> issue.
+
 ---
 
 ## Table of Contents
 
 - [Overview](#overview)
+- [Support & Scope](#support--scope)
 - [Features](#features)
 - [Sensors](#sensors)
 - [Control Entities](#control-entities)
@@ -56,6 +65,35 @@ The **Solar of Things** integration connects Home Assistant to the
 
 ---
 
+## Support & Scope
+
+This integration exists because the author owns a **Sumry 3600** inverter and
+wanted it in Home Assistant. It's published here in case it's useful to anyone
+else on the Siseli platform — not as a product with a support contract behind
+it.
+
+In practice, that means:
+
+- **Bug fixes are best-effort**, made when the author has time, and prioritized
+  toward the hardware they actually own and can test against.
+- **Reports about other inverter models, WiFi dongle variants, or firmware
+  families are genuinely welcome** — several real fixes in this project's
+  history came directly from a detailed report (exact field names, a raw API
+  capture, confirmed against real hardware). But a report alone doesn't
+  guarantee a fix, especially for hardware the author has no way to verify
+  against.
+- **There's no SLA, no roadmap commitment, and no guarantee any specific
+  device will ever be supported.**
+
+**You're encouraged to fork this repository.** The code is MIT-licensed
+specifically so you can adapt it to your own inverter, dongle, or firmware
+without waiting on anyone. If you build a fix for your hardware, a pull
+request back is very welcome — see [Contributing](#contributing) — but
+forking and maintaining your own copy is a completely legitimate way to use
+this project, not a fallback.
+
+---
+
 ## Features
 
 | Category | What you get |
@@ -345,6 +383,11 @@ Restart HA, reproduce the issue, then check **Settings → System → Logs**.
 
 ## Contributing
 
+Adding support for hardware the maintainer doesn't own is exactly what forking
+and contributing is for — see [Support & Scope](#support--scope). The fixes
+most likely to get merged are the ones that came with a real capture against
+real hardware, not a guess.
+
 1. Fork the repo and create a feature branch.
 2. Make changes and ensure Python syntax is valid:
    ```bash