diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml new file mode 100644 index 0000000..3440309 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -0,0 +1,68 @@ +name: Bug/Issue report +description: Report a issue related to the Roborock Local Server stack +labels: ["bug/issue"] +body: + - type: markdown + attributes: + value: >- + Thanks for taking the time to file a bug/issue! If instead you just want to + confirm the server/onboarding works (or does not work) on your device, please use + the [Compatibility Discussions + category](https://github.com/Python-roborock/local_roborock_server/discussions/categories/compatibility) + rather than opening an issue. + + - type: checkboxes + id: confirm-issue + attributes: + label: This is a real issue? + options: + - label: I have confirmed this is a issue, not a report that the project works on my device. + required: true + + - type: textarea + id: what-happened + attributes: + label: What happened? + description: Describe the issue/problem, including what you expected to happen instead. + placeholder: Onboarding fails after devices says connection to wifi... + validations: + required: true + + - type: textarea + id: reproduce + attributes: + label: Steps to reproduce + description: What did you do, in what order? + placeholder: | + 1. ... + 2. ... + 3. ... + validations: + required: true + + - type: input + id: vacuum + attributes: + label: Vacuum model + description: Which Roborock model are you trying on? + placeholder: Roborock S8 MaxV Ultra + validations: + required: false + + - type: input + id: version + attributes: + label: Server / image version + description: Which version or image tag are you running? + placeholder: ghcr.io/python-roborock/local_roborock_server:v1.0.2 + validations: + required: false + + - type: textarea + id: logs + attributes: + label: Relevant logs + description: Paste any relevant log output. This will be automatically formatted, no backticks needed. + render: shell + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..f6f5e90 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,8 @@ +blank_issues_enabled: false +contact_links: + - name: Device compatibility report + url: https://github.com/Python-roborock/local_roborock_server/discussions/categories/compatibility + about: >- + Confirming the server works (or does not work) on your vacuum? That goes in + the Compatibility Discussions category, not in Issues. Please share your + model, firmware, and which certificate chain you used so others can benefit. diff --git a/.github/ISSUE_TEMPLATE/feature.yml b/.github/ISSUE_TEMPLATE/feature.yml new file mode 100644 index 0000000..c913d4c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature.yml @@ -0,0 +1,28 @@ +name: Feature request +description: Suggest an idea or improvement for the project +labels: ["enhancement"] +body: + - type: textarea + id: problem + attributes: + label: What problem would this solve? + description: Describe the use case or the pain point behind the request. + placeholder: It would be great if... + validations: + required: true + + - type: textarea + id: proposal + attributes: + label: Proposed solution + description: How would you like this to work? + validations: + required: false + + - type: textarea + id: alternatives + attributes: + label: Alternatives considered + description: Any other approaches you have thought about. + validations: + required: false diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..d1e7f78 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,22 @@ +# Contributing + +If you would like to contribute there are a few ways that would be great! + +1. Code is always welcome that you have fully tested. +2. Video walkthroughs of how to actually set this up would be great. +3. Documentation. Human-written documentation always 'feels' better than what AI produces. + +## Where does my report go? + +To keep Issues focused and actionable, there are three destinations depending on what you have: + +- **Found a bug?** → Open an [Issue](https://github.com/Python-roborock/local_roborock_server/issues/new/choose). + Use the bug report form and confirm it is a real issue, not a "works on my device" note. +- **Confirming (or ruling out) that the server runs on your vacuum?** → Post in the + [Compatibility Discussions category](https://github.com/Python-roborock/local_roborock_server/discussions/categories/compatibility). + Please include your model, firmware, and which certificate chain you used. These reports do **not** + belong in Issues. +- **Have a confirmed, reproducible result to record?** → Open a pull request adding a row to + [Tested Vacuums.md](/docs/tested_vacuums.md) so the next person can find it quickly. + +Feature ideas are welcome as Issues too — use the feature request form.