Skip to content

Commit

Permalink
add issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
5ila5 committed Oct 29, 2023
1 parent 18a2dae commit 766db58
Show file tree
Hide file tree
Showing 2 changed files with 136 additions and 0 deletions.
80 changes: 80 additions & 0 deletions .github/ISSUE_TEMPLATE/BUG-REPORT.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
name: Bug Report
description: Report a bug with a source, sensor or the integration in general
title: "[Bug]: "
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this Bug Report!
- type: dropdown
id: error
attributes:
label: "I Have A Problem With:"
options:
- A specific source
- Sensor configuration
- The integration in general
multiple: true
validations:
required: true
- type: textarea
id: description
attributes:
label: What's Your Problem
description: Describe your problem as detailed as possible
validations:
required: true
- type: input
id: source
attributes:
label: Source (if relevant)
description: Which source are you using?
placeholder: ex. broxtowe_gov_uk
validations:
required: false
- type: textarea
id: logs
attributes:
label: Logs
description: Please provide relevant logs from Home Assistant if no relevant logs are available please write "no relevant logs" (please remove sensitive information or use example addresses)
render: Shell
validations:
required: false
- type: textarea
id: configuration
attributes:
label: Relevant Configuration
description: Please provide your configuration (source/sensor) if relevant (please remove sensitive information or use example addresses)
render: YAML
validations:
required: false
- type: checkboxes
id: checklist-source
attributes:
label: Checklist Source Error
description: Have you tried the following?
options:
- label: Use the example parameters for your source (often available in the documentation) (don't forget to restart Home Assistant after changing the configuration)
required: false
- label: Checked that the website of your service provider is still working
required: false
- label: Tested my attributes on the service provider website (if possible)
required: false
- type: checkboxes
id: checklist-sensor
attributes:
label: Checklist Sensor Error
description: Have you tried the following?
options:
- label: Checked in the Home Assistant Calendar tab if the event names match the types names (if types argument is used)
required: false
- type: checkboxes
id: checklist-general
attributes:
label: Required
description: "Please make sure you agree with these statements:"
options:
- label: I have searched past (closed AND opened) issues to see if this bug has already been reported, and it hasn't been.
required: true
- label: I understand that people give their precious time for free, and thus I've done my very best to make this problem as easy as possible to investigate.
required: true
56 changes: 56 additions & 0 deletions .github/ISSUE_TEMPLATE/SOURCE-REQUEST.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
name: Source Request
description: Request that a municipality or region is supported
title: "[Source Request]: "
labels: ["source request"]
body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this source request!
- type: input
id: region
attributes:
label: Municipality / Region
description: Which municipality or region should be supported in the future?
placeholder: ex. Berlin, Germany
validations:
required: true
- type: input
id: collection-url
attributes:
label: Collection Calendar Webpage
description: Where are information about bin collections listed (preferred ULR)
placeholder: https://example.com
validations:
required: false
- type: textarea
id: example-address
attributes:
label: Example Address
description: (preferred) An address or other needed parameter for getting your collection info (not your own)
placeholder: ex. Gundelfinger Str. 4, 10318 Berlin
validations:
required: false
- type: dropdown
id: format
attributes:
label: Collection Data Format
description: In which format does your service provider provides collection dates.
options:
- As ICS/ICAL file
- As html on a webpage
- Dedicated IOS/Android APP
- As PDF Download
- As documented API
- Something different (add to additional information)
multiple: true
validations:
required: true
- type: textarea
id: additional-information
attributes:
label: Additional Information
description: (optional) additional information that might be helpful to implement a source for the municipality / region
placeholder: Additional information
validations:
required: false

0 comments on commit 766db58

Please sign in to comment.