Skip to content

Commit bf94983

Browse files
edenhausCopilot
andcommitted
Contribution only (#1217)
Co-authored-by: Copilot <[email protected]>
1 parent 54a19ae commit bf94983

File tree

5 files changed

+109
-11
lines changed

5 files changed

+109
-11
lines changed

.github/ISSUE_TEMPLATE/bug_report.yml

Lines changed: 14 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,31 @@
11
name: Report an issue
22
description: Report an issue
3-
labels: [bug]
3+
type: Bug
44
body:
55
- type: markdown
66
attributes:
77
value: |
88
This issue form is for reporting bugs only!
9+
If you want to request a new feature or an enhancement, please use the other issues types.
910
10-
If you have a feature request or a question, please use discussions.
11+
This project is maintained in our spare time. Please be patient and respectful.
12+
It's not related to Ecovacs or Deebot and we don't get any support from them.
13+
As all is reverse engineered it might take some time to fix issues.
14+
Due to the fact that this is a hobby project, we can't guarantee that all issues will be fixed.
15+
Unfortunately some people think we are paid to do this and get angry if things don't work as they expect.
16+
As result of this, we decided that this project is in a contribution only mode.
17+
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.
18+
It's not allowed to ping any members of the project to ask for help or to fix your issue.
19+
If you do so, your issue will be closed without further notice.
1120
- type: checkboxes
1221
attributes:
1322
label: Checks
1423
options:
15-
- label: I have searched the existing issues and no issue is describing my issue
24+
- label: I have read the above text and I'm aware of the situation
1625
required: true
17-
- label: I have checked the [FAQ](https://deebot.readthedocs.io/home/faq/)
26+
- label: I have searched the existing issues and no issue is describing my issue
1827
required: true
19-
- label: I have checked the [documentation](https://deebot.readthedocs.io/integrations/home-assistant)
28+
- label: I'm not creating an issue to add support for a new device/model.
2029
required: true
2130
- label: I have installed the latest version
2231
required: true

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,5 @@
11
blank_issues_enabled: false
22
contact_links:
3-
- name: "❓ Ask a Question"
4-
url: https://github.com/DeebotUniverse/client.py/discussions/new
5-
about: For asking a question please select the category "Q&A"
6-
- name: "💡 Suggest an feature/idea"
7-
url: https://github.com/DeebotUniverse/client.py/discussions/new
8-
about: For feature request please select the category "Ideas"
3+
- name: "Home Assistant Ecovacs documentation"
4+
url: https://www.home-assistant.io/integrations/ecovacs
5+
about: Documentation how to use the Ecovacs integration in Home Assistant

.github/ISSUE_TEMPLATE/feature.yml

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
name: 💡 Suggest a feature/idea
2+
description: Suggest a feature/idea
3+
type: Feature
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
This issue form is for reporting features/ideas only!
9+
For others, please use the other issues types.
10+
11+
This project is maintained in our spare time. Please be patient and respectful.
12+
It's not related to Ecovacs or Deebot and we don't get any support from them.
13+
As all is reverse engineered it might take some time to add new features.
14+
Due to the fact that this is a hobby project, we can't guarantee that all features will be added.
15+
Unfortunately some people think we are paid to do this and get angry if things don't work as they expect.
16+
As result of this, we decided that this project is in a contribution only mode.
17+
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.
18+
It's not allowed to ping any members of the project to ask for help.
19+
If you do so, your issue will be closed without further notice.
20+
- type: checkboxes
21+
attributes:
22+
label: Checks
23+
options:
24+
- label: I have read the above text and I'm aware of the situation
25+
required: true
26+
- label: I have searched the existing issues and no issue is describing my issue
27+
required: true
28+
- label: I have installed the latest version
29+
required: true
30+
31+
- type: textarea
32+
validations:
33+
required: true
34+
attributes:
35+
label: The feature you want to suggest
36+
description: >-
37+
Describe the feature you want to suggest here to communicate to the
38+
maintainers. Tell us what you were trying to do and what happened.
39+
40+
Provide a clear and concise description of what the feature is.
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
name: ❓ Ask a Question
2+
description: Ask a Question
3+
type: Question
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
This issue form is for general questions only!
9+
For others, please use the other issues types.
10+
11+
This project is maintained in our spare time. Please be patient and respectful.
12+
It's not related to Ecovacs or Deebot and we don't get any support from them.
13+
As all is reverse engineered it might take some time to add new features.
14+
Due to the fact that this is a hobby project, we can't guarantee that all features will be added.
15+
Unfortunately some people think we are paid to do this and get angry if things don't work as they expect.
16+
As result of this, we decided that this project is in a contribution only mode.
17+
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.
18+
It's not allowed to ping any members of the project to ask for help.
19+
If you do so, your issue will be closed without further notice.
20+
- type: checkboxes
21+
attributes:
22+
label: Checks
23+
options:
24+
- label: I have read the above text and I'm aware of the situation
25+
required: true
26+
- label: I have searched the existing issues and no issue is describing my issue
27+
required: true
28+
29+
- type: textarea
30+
validations:
31+
required: true
32+
attributes:
33+
label: The question you want to ask
34+
description: >-
35+
Describe the question you want to ask here to communicate to the
36+
maintainers. Tell us what you were trying to do and what happened.
37+
38+
Provide a clear and concise description of what the question is.

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,20 @@
33
[![PyPI - Downloads](https://img.shields.io/pypi/dw/deebot-client?style=for-the-badge)](https://pypi.org/project/deebot-client)
44
<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>
55

6+
## IMPORTANT: Contribution only
7+
8+
This project is maintained in our spare time. Please be patient and respectful.
9+
10+
It's not related to Ecovacs or Deebot and we don't get any support from them.
11+
12+
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.
13+
14+
Unfortunately some people think we are paid to do this and get angry if things don't work as they expect.
15+
**As result of this, we decided that this project is in a contribution only mode.**
16+
17+
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.
18+
Members will still review and help on pull requests.
19+
620
## Installation
721

822
If you have a recent version of Python 3, you should be able to

0 commit comments

Comments
 (0)