From f12160dc3055e12bc6f5aa297168c8ffd45c8073 Mon Sep 17 00:00:00 2001 From: Robert Resch Date: Fri, 10 Oct 2025 09:25:28 +0000 Subject: [PATCH 1/6] Contribution only --- .github/ISSUE_TEMPLATE/bug_report.yml | 19 +++++++++---- .github/ISSUE_TEMPLATE/config.yml | 7 ----- .github/ISSUE_TEMPLATE/feature.yml | 40 +++++++++++++++++++++++++++ .github/ISSUE_TEMPLATE/question.yml | 38 +++++++++++++++++++++++++ README.md | 10 +++++++ 5 files changed, 102 insertions(+), 12 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/feature.yml create mode 100644 .github/ISSUE_TEMPLATE/question.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index e76611d88..31e64a07f 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -1,22 +1,31 @@ name: Report an issue description: Report an issue -labels: [bug] +type: Bug body: - type: markdown attributes: value: | This issue form is for reporting bugs only! + If you want to request a new feature or an enhancement, please use the other issues types. - If you have a feature request or a question, please use discussions. + This project is maintained in our spare time. Please be patient and respectful. + It's not related to Ecovacs or Deebot and we don't get any support from them. + As all is reverse engineered it might take some time to fix issues. + Due the fact that this is a hobby project, we can't guarantee that all issues will be fixed. + Unfortunately some people think we are paid to do this and get angry if things don't work as they expect. + As result of this, we decided that this project is in a contribution only mode. + This means, if you want something to be fixed, you have to provide a fix yourself, wait for someone else to fix it or pay someone to do it. + It's not allowed to ping any members of the project to ask for help or to fix your issue. + If you do so, your issue will be closed without further notice. - type: checkboxes attributes: label: Checks options: - - label: I have searched the existing issues and no issue is describing my issue + - label: I have read the above text and I'm aware of the situation required: true - - label: I have checked the [FAQ](https://deebot.readthedocs.io/home/faq/) + - label: I have searched the existing issues and no issue is describing my issue required: true - - label: I have checked the [documentation](https://deebot.readthedocs.io/integrations/home-assistant) + - label: I'm not creating an issue to add support for a new device/model. required: true - label: I have installed the latest version required: true diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 6ae6d25d1..3ba13e0ce 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,8 +1 @@ blank_issues_enabled: false -contact_links: - - name: "❓ Ask a Question" - url: https://github.com/DeebotUniverse/client.py/discussions/new - about: For asking a question please select the category "Q&A" - - name: "💡 Suggest an feature/idea" - url: https://github.com/DeebotUniverse/client.py/discussions/new - about: For feature request please select the category "Ideas" diff --git a/.github/ISSUE_TEMPLATE/feature.yml b/.github/ISSUE_TEMPLATE/feature.yml new file mode 100644 index 000000000..f5d8cfb00 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature.yml @@ -0,0 +1,40 @@ +name: 💡 Suggest an feature/idea +description: Suggest an feature/idea +type: Feature +body: + - type: markdown + attributes: + value: | + This issue form is for reporting features/ideas only! + For others, please use the other issues types. + + This project is maintained in our spare time. Please be patient and respectful. + It's not related to Ecovacs or Deebot and we don't get any support from them. + As all is reverse engineered it might take some time to add new features. + Due the fact that this is a hobby project, we can't guarantee that all features will be added. + Unfortunately some people think we are paid to do this and get angry if things don't work as they expect. + As result of this, we decided that this project is in a contribution only mode. + This means, if you want something to be supported/added, you have to provide a fix yourself, wait for someone else to fix it or pay someone to do it. + It's not allowed to ping any members of the project to ask for help. + If you do so, your issue will be closed without further notice. + - type: checkboxes + attributes: + label: Checks + options: + - label: I have read the above text and I'm aware of the situation + required: true + - label: I have searched the existing issues and no issue is describing my issue + required: true + - label: I have installed the latest version + required: true + + - type: textarea + validations: + required: true + attributes: + label: The feature you want to suggest + description: >- + Describe the feature you want to suggest here to communicate to the + maintainers. Tell us what you were trying to do and what happened. + + Provide a clear and concise description of what the feature is. diff --git a/.github/ISSUE_TEMPLATE/question.yml b/.github/ISSUE_TEMPLATE/question.yml new file mode 100644 index 000000000..753bc526f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.yml @@ -0,0 +1,38 @@ +name: ❓ Ask a Question +description: Ask a Question +type: Question +body: + - type: markdown + attributes: + value: | + This issue form is for general questions only! + For others, please use the other issues types. + + This project is maintained in our spare time. Please be patient and respectful. + It's not related to Ecovacs or Deebot and we don't get any support from them. + As all is reverse engineered it might take some time to add new features. + Due the fact that this is a hobby project, we can't guarantee that all features will be added. + Unfortunately some people think we are paid to do this and get angry if things don't work as they expect. + As result of this, we decided that this project is in a contribution only mode. + This means, if you want something to be supported/added, you have to provide a fix yourself, wait for someone else to fix it or pay someone to do it. + It's not allowed to ping any members of the project to ask for help. + If you do so, your issue will be closed without further notice. + - type: checkboxes + attributes: + label: Checks + options: + - label: I have read the above text and I'm aware of the situation + required: true + - label: I have searched the existing issues and no issue is describing my issue + required: true + + - type: textarea + validations: + required: true + attributes: + label: The question you want to ask + description: >- + Describe the question you want to ask here to communicate to the + maintainers. Tell us what you were trying to do and what happened. + + Provide a clear and concise description of what the question is. diff --git a/README.md b/README.md index cfd77c732..01ed98491 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,16 @@ [![PyPI - Downloads](https://img.shields.io/pypi/dw/deebot-client?style=for-the-badge)](https://pypi.org/project/deebot-client) Buy Me A Coffee +## IMPORTANT: Contribution only + +This project is maintained in our spare time. Please be patient and respectful. +It's not related to Ecovacs or Deebot and we don't get any support from them. +As all is reverse engineered it might take some time to add new features and we can't guarantee that all features will be added. +Unfortunately some people think we are paid to do this and get angry if things don't work as they expect. +**As result of this, we decided that this project is in a contribution only mode.** +This means, if you want something to be supported/added, you have to provide a fix yourself, wait for someone else to fix it or pay someone to do it. +Members will still review and help on pull requests. + ## Installation If you have a recent version of Python 3, you should be able to From 302e0f4f47c7f767522606cfc9fce887f15f849c Mon Sep 17 00:00:00 2001 From: Robert Resch Date: Fri, 10 Oct 2025 09:27:34 +0000 Subject: [PATCH 2/6] styling --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 01ed98491..e283ff0bb 100644 --- a/README.md +++ b/README.md @@ -6,10 +6,14 @@ ## IMPORTANT: Contribution only This project is maintained in our spare time. Please be patient and respectful. + It's not related to Ecovacs or Deebot and we don't get any support from them. + As all is reverse engineered it might take some time to add new features and we can't guarantee that all features will be added. + Unfortunately some people think we are paid to do this and get angry if things don't work as they expect. **As result of this, we decided that this project is in a contribution only mode.** + This means, if you want something to be supported/added, you have to provide a fix yourself, wait for someone else to fix it or pay someone to do it. Members will still review and help on pull requests. From 2095a40575e3bec3166b8fba7afeb538cafb2992 Mon Sep 17 00:00:00 2001 From: Robert Resch Date: Fri, 10 Oct 2025 11:28:29 +0200 Subject: [PATCH 3/6] Update .github/ISSUE_TEMPLATE/feature.yml Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- .github/ISSUE_TEMPLATE/feature.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/feature.yml b/.github/ISSUE_TEMPLATE/feature.yml index f5d8cfb00..345864ddd 100644 --- a/.github/ISSUE_TEMPLATE/feature.yml +++ b/.github/ISSUE_TEMPLATE/feature.yml @@ -1,5 +1,5 @@ -name: 💡 Suggest an feature/idea -description: Suggest an feature/idea +name: 💡 Suggest a feature/idea +description: Suggest a feature/idea type: Feature body: - type: markdown From ad0cf83ecbd6c6af686016f10b961f91e48cb9b8 Mon Sep 17 00:00:00 2001 From: Robert Resch Date: Fri, 10 Oct 2025 11:28:35 +0200 Subject: [PATCH 4/6] Update .github/ISSUE_TEMPLATE/question.yml Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- .github/ISSUE_TEMPLATE/question.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/question.yml b/.github/ISSUE_TEMPLATE/question.yml index 753bc526f..359064bc5 100644 --- a/.github/ISSUE_TEMPLATE/question.yml +++ b/.github/ISSUE_TEMPLATE/question.yml @@ -11,7 +11,7 @@ body: This project is maintained in our spare time. Please be patient and respectful. It's not related to Ecovacs or Deebot and we don't get any support from them. As all is reverse engineered it might take some time to add new features. - Due the fact that this is a hobby project, we can't guarantee that all features will be added. + Due to the fact that this is a hobby project, we can't guarantee that all features will be added. Unfortunately some people think we are paid to do this and get angry if things don't work as they expect. As result of this, we decided that this project is in a contribution only mode. This means, if you want something to be supported/added, you have to provide a fix yourself, wait for someone else to fix it or pay someone to do it. From 5cd9921681b807af864bfa90bd469d6ae6dcdbfd Mon Sep 17 00:00:00 2001 From: Robert Resch Date: Fri, 10 Oct 2025 11:28:42 +0200 Subject: [PATCH 5/6] Update .github/ISSUE_TEMPLATE/feature.yml Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- .github/ISSUE_TEMPLATE/feature.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/feature.yml b/.github/ISSUE_TEMPLATE/feature.yml index 345864ddd..81cb7f036 100644 --- a/.github/ISSUE_TEMPLATE/feature.yml +++ b/.github/ISSUE_TEMPLATE/feature.yml @@ -11,7 +11,7 @@ body: This project is maintained in our spare time. Please be patient and respectful. It's not related to Ecovacs or Deebot and we don't get any support from them. As all is reverse engineered it might take some time to add new features. - Due the fact that this is a hobby project, we can't guarantee that all features will be added. + Due to the fact that this is a hobby project, we can't guarantee that all features will be added. Unfortunately some people think we are paid to do this and get angry if things don't work as they expect. As result of this, we decided that this project is in a contribution only mode. This means, if you want something to be supported/added, you have to provide a fix yourself, wait for someone else to fix it or pay someone to do it. From 609afc8a5a46ed0fce4d6ce789f3774e22821431 Mon Sep 17 00:00:00 2001 From: Robert Resch Date: Fri, 10 Oct 2025 11:29:17 +0200 Subject: [PATCH 6/6] Update .github/ISSUE_TEMPLATE/bug_report.yml Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- .github/ISSUE_TEMPLATE/bug_report.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 31e64a07f..137a72468 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -11,7 +11,7 @@ body: This project is maintained in our spare time. Please be patient and respectful. It's not related to Ecovacs or Deebot and we don't get any support from them. As all is reverse engineered it might take some time to fix issues. - Due the fact that this is a hobby project, we can't guarantee that all issues will be fixed. + Due to the fact that this is a hobby project, we can't guarantee that all issues will be fixed. Unfortunately some people think we are paid to do this and get angry if things don't work as they expect. As result of this, we decided that this project is in a contribution only mode. This means, if you want something to be fixed, you have to provide a fix yourself, wait for someone else to fix it or pay someone to do it.