From a1fdebc32a7a979b7722647502116b2738752035 Mon Sep 17 00:00:00 2001 From: Mattheus Date: Sat, 1 Apr 2023 17:20:26 +0200 Subject: [PATCH 1/5] Update issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 38 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/custom.md | 10 ++++++ .github/ISSUE_TEMPLATE/feature_request.md | 20 ++++++++++++ 3 files changed, 68 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/custom.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..dd84ea7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,38 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: '' +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If applicable, add screenshots to help explain your problem. + +**Desktop (please complete the following information):** + - OS: [e.g. iOS] + - Browser [e.g. chrome, safari] + - Version [e.g. 22] + +**Smartphone (please complete the following information):** + - Device: [e.g. iPhone6] + - OS: [e.g. iOS8.1] + - Browser [e.g. stock browser, safari] + - Version [e.g. 22] + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/custom.md b/.github/ISSUE_TEMPLATE/custom.md new file mode 100644 index 0000000..48d5f81 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/custom.md @@ -0,0 +1,10 @@ +--- +name: Custom issue template +about: Describe this issue template's purpose here. +title: '' +labels: '' +assignees: '' + +--- + + diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..bbcbbe7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -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. From 334b220cd893b8b701abefda053062999d790901 Mon Sep 17 00:00:00 2001 From: Mattheus Date: Sat, 1 Apr 2023 17:30:28 +0200 Subject: [PATCH 2/5] Update bug_report.md --- .github/ISSUE_TEMPLATE/bug_report.md | 45 ++++++++++++++-------------- 1 file changed, 23 insertions(+), 22 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index dd84ea7..72c0f00 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,38 +1,39 @@ --- name: Bug report about: Create a report to help us improve -title: '' -labels: '' +title: "[BUG]" +labels: bug assignees: '' - --- -**Describe the bug** -A clear and concise description of what the bug is. + -**To Reproduce** +# Bug report + +## Describe the bug +Add a description of the bug. Detail the expected behaviour in contrast with the behaviour you're observing. + +## Additional information + +- Devices involved: + - Model: Ulanzi Awtrix Smart Pixel Clock 2882 (TC001) + - AWTRIX-LIGHT version: [ eg. v0.0.45 ] + +## To Reproduce Steps to reproduce the behavior: -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error -**Expected behavior** + +## Expected behavior A clear and concise description of what you expected to happen. -**Screenshots** +## Screenshots If applicable, add screenshots to help explain your problem. -**Desktop (please complete the following information):** - - OS: [e.g. iOS] - - Browser [e.g. chrome, safari] - - Version [e.g. 22] +## Logs -**Smartphone (please complete the following information):** - - Device: [e.g. iPhone6] - - OS: [e.g. iOS8.1] - - Browser [e.g. stock browser, safari] - - Version [e.g. 22] +```text +(optional) Add relevant logs which could help tackle the problem. +``` -**Additional context** +## Additional context Add any other context about the problem here. From 5874f3942f621b82df332484c48a25f63182f528 Mon Sep 17 00:00:00 2001 From: Mattheus Date: Sat, 1 Apr 2023 17:31:22 +0200 Subject: [PATCH 3/5] Update bug_report.md --- .github/ISSUE_TEMPLATE/bug_report.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 72c0f00..3ebb04b 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -17,7 +17,7 @@ Add a description of the bug. Detail the expected behaviour in contrast with the - Devices involved: - Model: Ulanzi Awtrix Smart Pixel Clock 2882 (TC001) - - AWTRIX-LIGHT version: [ eg. v0.0.45 ] + - AWTRIX-LIGHT version: [ eg. v0.45 ] ## To Reproduce Steps to reproduce the behavior: From 45fa8d28c5feb91e1196d7b96678f033b98b7d5f Mon Sep 17 00:00:00 2001 From: Mattheus Date: Sat, 1 Apr 2023 17:33:48 +0200 Subject: [PATCH 4/5] Update feature_request.md --- .github/ISSUE_TEMPLATE/feature_request.md | 22 +++++++++++++++------- 1 file changed, 15 insertions(+), 7 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index bbcbbe7..74afa32 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -1,20 +1,28 @@ --- name: Feature request about: Suggest an idea for this project -title: '' -labels: '' +title: "[FEATURE REQUEST]" +labels: feature request 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 [...] + + +# Feature Request + +### Is your feature request related to a problem? + +If so, then add a clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +### Describe the solution / feature you'd like -**Describe the solution you'd like** A clear and concise description of what you want to happen. -**Describe alternatives you've considered** +### Describe alternatives you've considered + A clear and concise description of any alternative solutions or features you've considered. -**Additional context** +### Additional context + Add any other context or screenshots about the feature request here. From 604559624cd22360e099a91159dd5c6a9f18e4cd Mon Sep 17 00:00:00 2001 From: Mattheus Date: Sat, 1 Apr 2023 17:37:52 +0200 Subject: [PATCH 5/5] Update and rename custom.md to question.md --- .github/ISSUE_TEMPLATE/custom.md | 10 ---------- .github/ISSUE_TEMPLATE/question.md | 30 ++++++++++++++++++++++++++++++ 2 files changed, 30 insertions(+), 10 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/custom.md create mode 100644 .github/ISSUE_TEMPLATE/question.md diff --git a/.github/ISSUE_TEMPLATE/custom.md b/.github/ISSUE_TEMPLATE/custom.md deleted file mode 100644 index 48d5f81..0000000 --- a/.github/ISSUE_TEMPLATE/custom.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -name: Custom issue template -about: Describe this issue template's purpose here. -title: '' -labels: '' -assignees: '' - ---- - - diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md new file mode 100644 index 0000000..3e89cd4 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.md @@ -0,0 +1,30 @@ +--- +name: Question +about: Open an issue to ask something +title: "[QUESTION]" +labels: question +assignees: '' + +--- + + + +# Question + +Add here your question. + + +## Additional information + +- Devices involved: + - Model: Ulanzi Awtrix Smart Pixel Clock 2882 (TC001) + - AWTRIX-LIGHT version: [ eg. v0.45 ] + +## Logs + +```text +(optional) Add relevant logs which could help tackle the problem. +``` + +## Additional context +Add any other context about the problem here.