Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
19 changes: 14 additions & 5 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -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 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.
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
Expand Down
7 changes: 0 additions & 7 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -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"
40 changes: 40 additions & 0 deletions .github/ISSUE_TEMPLATE/feature.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
name: 💡 Suggest a feature/idea
description: Suggest a 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 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.
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.
38 changes: 38 additions & 0 deletions .github/ISSUE_TEMPLATE/question.yml
Original file line number Diff line number Diff line change
@@ -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 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.
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.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,20 @@
[![PyPI - Downloads](https://img.shields.io/pypi/dw/deebot-client?style=for-the-badge)](https://pypi.org/project/deebot-client)
<a href="https://www.buymeacoffee.com/edenhaus" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/default-black.png" width="150px" height="35px" alt="Buy Me A Coffee" style="height: 35px !important;width: 150px !important;" ></a>

## 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
Expand Down
Loading