Skip to content

Commit

Permalink
tools: add GitHub templates for bug reporting / features / pull reque…
Browse files Browse the repository at this point in the history
…sts (#13)

#13
  • Loading branch information
palazzem authored Sep 1, 2023
1 parent 2e74d6a commit a9c8439
Show file tree
Hide file tree
Showing 4 changed files with 74 additions and 0 deletions.
29 changes: 29 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
name: Bug report
about: Errors you encountered
title: ''
labels: ''
assignees: ''

---

**Describe the bug**
A clear and concise description of what the bug is.

**Error message**
Error that was thrown (if available)

**Expected behavior**
A clear and concise description of what you expected to happen.

**Additional context**
Add any other context about the problem here, like configuration you have in place, network connection, etc.

**To Reproduce**
Steps to reproduce the behavior

**Environment**
- Operating System (OS):
- Library version (commit or version number):
- Home Assistant version:
- Last working Home Assistant release (if known):
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: Something unclear? Just ask to our community!
url: https://discord.gg/NSmAPWw8tE
about: Join our Discord channel!
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: ''
assignees: ''

---

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here.
20 changes: 20 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
### Related Issues

- #issue-number

### Proposed Changes:
<!--- In case of a bug: Describe what caused the issue and how you solved it -->
<!--- In case of a feature: Describe what did you add and how it works -->

### Testing:
<!-- unit tests, integration tests, manual verification, instructions for manual tests -->

### Extra Notes (optional):
<!-- E.g. point out sections where the reviewer should validate your reasoning -->
<!-- E.g. point out questions that are still opened -->

### Checklist

- [ ] Related issues and proposed changes are filled
- [ ] Tests are defining the correct and expected behavior
- [ ] Code is well-documented via docstrings

0 comments on commit a9c8439

Please sign in to comment.