Skip to content

Commit

Permalink
github: setup issue and PR templates
Browse files Browse the repository at this point in the history
  • Loading branch information
Palakis committed Jul 9, 2024
1 parent 2c8daad commit 07fd40b
Show file tree
Hide file tree
Showing 3 changed files with 97 additions and 0 deletions.
72 changes: 72 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
name: Report an issue with esphome-native-hdmi-cec
description: Create a report to help esphome-native-hdmi-cec improve.
title: "[Bug]: "
labels: ["bug", "needs triage"]
body:
- type: textarea
validations:
required: true
id: problem
attributes:
label: The problem
description: >-
Describe the issue you are experiencing here to communicate to the
maintainer(s). Tell us what you were trying to do and what happened.
Provide a clear and concise description of what the problem is.
- type: markdown
attributes:
value: |
## Environment
- type: input
id: version
validations:
required: true
attributes:
label: Which version of ESPHome was used when this happened?
description: >
ESPHome version like 1.19, 2021.9.0 or 2021.XX.X-dev.
- type: dropdown
validations:
required: true
id: platform
attributes:
label: What platform are you using?
options:
- ESP8266
- ESP32
- ESP32-IDF
- RP2040
- BK72XX
- RTL87XX
- type: input
id: board
attributes:
label: Board
description: >
The name of the board you are using. For example, sonoff basic, nodemcu, shelly.
- type: markdown
attributes:
value: |
# Details
- type: textarea
id: config
attributes:
label: Example YAML snippet
description: |
If this issue has an example piece of YAML that can help reproducing this problem, please provide it here. Preferably reduce your config to the smallest possible file to reproduce the problem, or post the entire YAML. Posting a YAML fragment that cannot be compiled without changes will lessen the chance that your issue will be responded to promptly.
render: yaml
- type: textarea
id: logs
attributes:
label: Anything in the logs that might be useful?
description: For example, error message, or stack traces.
render: txt
- type: textarea
id: additional
attributes:
label: Additional information
description: >
If you have any additional information, use the field below.
Please note, you can attach screenshots or screen recordings here, by
dragging and dropping files in the field below.
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: false
24 changes: 24 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
name: Feature request
about: Suggest an idea for esphome-native-hdmi-cec
title: "[Feature]: "
labels: feature, needs triage
---

<!-- READ THIS FIRST:
- Please be as descriptive as possible, especially use-cases that can otherwise not be solved boost the problem's priority.
DO NOT DELETE ANY TEXT from this template! Otherwise the issue may be closed without a comment.
-->

**Describe what new feature you would like**
<!-- A description of what you want to happen. -->

**Please describe your use case for this feature and alternatives you've tried:**
<!-- A clear and concise description of what the problem is. -->

**Additional context**
<!-- Add any other context about the feature request here. -->


<!-- LEAVE THIS LINE AS-IS AND DON'T DELETE IT, OTHERWISE THE FEATURE REQUEST WILL BE CLOSED. -->

0 comments on commit 07fd40b

Please sign in to comment.