From abb28c4e5be2c19dd0194fabf08eb6107107ca22 Mon Sep 17 00:00:00 2001 From: Jokob-sk Date: Sat, 6 Jan 2024 12:48:30 +1100 Subject: [PATCH] Issue templates --- .github/ISSUE_TEMPLATE/feature_request.md | 20 ------ .github/ISSUE_TEMPLATE/feature_request.yml | 38 +++++++++++ .github/ISSUE_TEMPLATE/i-have-an-issue.md | 46 ------------- .github/ISSUE_TEMPLATE/i-have-an-issue.yml | 78 ++++++++++++++++++++++ 4 files changed, 116 insertions(+), 66 deletions(-) delete mode 100755 .github/ISSUE_TEMPLATE/feature_request.md create mode 100755 .github/ISSUE_TEMPLATE/feature_request.yml delete mode 100755 .github/ISSUE_TEMPLATE/i-have-an-issue.md create mode 100755 .github/ISSUE_TEMPLATE/i-have-an-issue.yml diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100755 index bbcbbe7d..00000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -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. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100755 index 00000000..660f0420 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,38 @@ +name: Feature Request +description: 'Suggest an idea for PiAlert' +labels: ['Feature request➕'] +body: +- type: checkboxes + attributes: + label: Is there an existing issue for this? + description: Please search to see if an open or closed issue already exists for the feature you are requesting. + options: + - label: I have searched the existing open and closed issues + required: true +- type: textarea + attributes: + label: Is your feature request related to a problem? Please describe + description: A clear and concise description of what the problem is. + validations: + required: true +- type: textarea + attributes: + label: Describe the solution you'd like + description: A clear and concise description of what you want to happen. + validations: + required: true +- type: textarea + attributes: + label: Describe alternatives you've considered + description: A clear and concise description of any alternative solutions or features you've considered. + validations: + required: true +- type: textarea + attributes: + label: Anything else? + description: | + Links? References? Mockups? Anything that will give us more context about the feature you are encountering! + + Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in. + validations: + required: true \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/i-have-an-issue.md b/.github/ISSUE_TEMPLATE/i-have-an-issue.md deleted file mode 100755 index 88cc1ead..00000000 --- a/.github/ISSUE_TEMPLATE/i-have-an-issue.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -name: I have an issue -about: Describe this issue template's purpose here. -title: '' -labels: '' -assignees: '' - ---- - -## Describe the issue - -> When submitting an issue ❗[enable debug](https://github.com/jokob-sk/Pi.Alert/blob/main/docs/DEBUG_TIPS.md)❗ and [have a look at the docs](https://github.com/jokob-sk/Pi.Alert/tree/main/docs) - -[describe your issue] - -## Paste your `pialert.conf` (remove personal info) - -``` -paste_here -``` - -## Paste your `docker-compose.yml` and `.env` (remove personal info) - -`docker-compose.yml` - -``` -paste_here -``` - -`.env` - -``` -paste_here -``` - -## Screenshots - -[If applicable, add screenshots to help explain your problem.] - -## Paste last few lines from `pialert.log` - -> You can use `tail -100 /home/pi/pialert/front/log/pialert.log` - -```bash - -# paste code below diff --git a/.github/ISSUE_TEMPLATE/i-have-an-issue.yml b/.github/ISSUE_TEMPLATE/i-have-an-issue.yml new file mode 100755 index 00000000..eca71891 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/i-have-an-issue.yml @@ -0,0 +1,78 @@ +name: Bug Report +description: 'When submitting an issue ❗[enable debug](https://github.com/jokob-sk/Pi.Alert/blob/main/docs/DEBUG_TIPS.md)❗ and [have a look at the docs](https://github.com/jokob-sk/Pi.Alert/tree/main/docs)' +labels: ['bug🐛'] +body: +- type: checkboxes + attributes: + label: Is there an existing issue for this? + description: Please search to see if an open or closed issue already exists for the bug you encountered. + options: + - label: I have searched the existing open and closed issues + required: true +- type: textarea + attributes: + label: Current Behavior + description: A concise description of what you're experiencing. + validations: + required: true +- type: textarea + attributes: + label: Expected Behavior + description: A concise description of what you expected to happen. + validations: + required: true +- type: textarea + attributes: + label: Steps To Reproduce + description: Steps to reproduce the behavior. + placeholder: | + 1. With these settings... + 2. With this config... + 3. Run '...' + 4. See error... + validations: + required: false +- type: textarea + attributes: + label: pialert.conf + description: | + Paste your `pialert.conf` (remove personal info) + render: python + validations: + required: false +- type: textarea + attributes: + label: docker-compose.yml + description: | + Paste your `docker-compose.yml` + render: python + validations: + required: false +- type: dropdown + attributes: + label: What branch are you running? + options: + - Master + - Develop + - Nightly + - Other (This issue will be closed) + validations: + required: true +- type: textarea + attributes: + label: pialert.log + description: | + Logs with debug enabled (https://github.com/jokob-sk/Pi.Alert/blob/main/docs/DEBUG_TIPS.md) + ***Generally speaking, all bug reports should have logs provided.*** + Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in. + Additionally, any additional info? Screenshots? References? Anything that will give us more context about the issue you are encountering! + You can use `tail -100 /home/pi/pialert/front/log/pialert.log` in teh container if you have troubles getting to the log files. + validations: + required: false +- type: checkboxes + attributes: + label: Debug enabled + description: I confirm I enabled `debug` + options: + - label: I have read and followed the steps in the wiki link above and provided the required debug logs and the log section covers the time when the issue occurs. + required: true