Skip to content

Commit 4b44786

Browse files
committed
PR and Bugreport templates
1 parent 704b0f4 commit 4b44786

File tree

4 files changed

+142
-0
lines changed

4 files changed

+142
-0
lines changed
Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
---
2+
name: Report a bug with NetDaemon
3+
about: Report an issue with NetDaemon
4+
---
5+
<!-- READ THIS FIRST:
6+
- If you need additional help with this template, please refer to https://netdaemon.xtz/help/reporting_issues/
7+
- Make sure you are running the latest version of NetDaemon before reporting an issue: https://github.com/net-daemon/netdaemon/releases
8+
- Do not use issues for support, we have the discord server for that purpose. https://discord.gg/K3xwfcX
9+
- Provide as many details as possible. Paste logs, configuration samples and code into the backticks.
10+
DO NOT DELETE ANY TEXT from this template! Otherwise, your issue may be closed without comment.
11+
-->
12+
## The problem
13+
<!--
14+
Describe the issue you are experiencing here to communicate to the
15+
maintainers. Tell us what you were trying to do and what happened.
16+
-->
17+
18+
19+
## Environment
20+
<!--
21+
Provide details about the versions you are using, which helps us to reproduce
22+
and find the issue quicker. Version information is found in the
23+
in the logs at startup.
24+
-->
25+
26+
- NetDaemon release with the issue:
27+
- Last working NetDaemon release (if known):
28+
- Operating environment (Home assistant Add-on/Docker/Dev setup):
29+
- Link to integration documentation on our website:
30+
31+
## Link to or paste code that causes the issue
32+
<!--
33+
Example of code that causes the issue.
34+
-->
35+
36+
```c#
37+
38+
```
39+
40+
## Traceback/Error logs
41+
<!--
42+
If you come across any trace or error logs, please provide them.
43+
-->
44+
45+
```txt
46+
47+
```
48+
49+
## Additional information

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Report a bug with NetDaemon
4+
url: https://github.com/net-daemon/netdaemon/issues
5+
about: This is the main issue tracker for NetDaemon. Please report issues with the NetDaemon there.
6+
- name: Report incorrect or missing information on the docs
7+
url: https://github.com/net-daemon/docs/issues
8+
about: Our documentation has its own issue tracker. Please report issues with the website there or even better contribute a PR.
9+
- name: I have a question or need support
10+
url: https://discord.gg/K3xwfcX
11+
about: Joint the Discord server to get support from the community.
12+
- name: Feature Request
13+
url: https://discord.gg/K3xwfcX
14+
about: Please join the Discord server and ask for a feature in the feature request channel
15+
- name: I'm unsure where to go
16+
url: https://discord.gg/K3xwfcX
17+
about: If you are unsure where to go, then joining our chat in Discord is recommended; Just ask!

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
<!--
2+
You are amazing! Thanks for contributing to our project!
3+
Please, DO NOT DELETE ANY TEXT from this template! (unless instructed).
4+
-->
5+
## Breaking change
6+
<!--
7+
If the PR contains a breaking change for existing users, it is important
8+
to tell them what breaks, how to make it work again and why we did this.
9+
This piece of text is published with the release notes, so it helps if you
10+
write it towards the users, not the devs.
11+
Note: Remove this section if this PR is NOT a breaking change.
12+
-->
13+
14+
15+
## Proposed change
16+
<!--
17+
Describe the big picture of your changes here to communicate to the
18+
maintainers why we should accept this pull request. If it fixes a bug
19+
or resolves a feature request, be sure to link to that issue in the
20+
additional information section.
21+
-->
22+
23+
24+
## Type of change
25+
<!--
26+
What type of change does your PR introduce to Home Assistant?
27+
NOTE: Please, check only 1! box!
28+
If your PR requires multiple boxes to be checked, you'll most likely need to
29+
split it into multiple PRs. This makes things easier and faster to code review.
30+
-->
31+
32+
- [ ] Dependency upgrade
33+
- [ ] Bugfix (non-breaking change which fixes an issue)
34+
- [ ] New feature (which adds functionality to an existing integration)
35+
- [ ] Breaking change (fix/feature causing existing functionality to break)
36+
- [ ] Code quality improvements to existing code or addition of tests
37+
38+
## Additional information
39+
<!--
40+
Details are important, and help maintainers processing your PR.
41+
Please be sure to fill out additional details, if applicable.
42+
-->
43+
44+
- This PR fixes or closes issue: fixes #
45+
- This PR is related to issue:
46+
- Link to documentation pull request:
47+
48+
## Checklist
49+
<!--
50+
Put an `x` in the boxes that apply. You can also fill these out after
51+
creating the PR. If you're unsure about any of them, don't hesitate to ask.
52+
We're here to help! This is simply a reminder of what we are going to look
53+
for before merging your code.
54+
-->
55+
56+
- [ ] The code change is tested and works locally.
57+
- [ ] Local tests pass. **Your PR cannot be merged unless tests pass**
58+
- [ ] There is no commented out code in this PR.
59+
- [ ] I have followed the [development checklist][dev-checklist]
60+
- [ ] The code compiles without warnings (code quality chek)
61+
- [ ] Tests have been added to verify that the new code works.
62+
63+
If user exposed functionality or configuration variables are added/changed:
64+
65+
- [ ] Documentation added/updated for [www.home-assistant.io][docs-repository]
66+
67+
68+
<!--
69+
Thank you for contributing <3
70+
71+
Below, some useful links you could explore:
72+
-->
73+
[docs-repository]: https://github.com/net-daemon/docs

.github/config.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
todo:
2+
keyword: "// todo:"
3+
body: "// body:"

0 commit comments

Comments
 (0)