diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 3e6c71cf..00000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: "[BUG]" -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 '....' -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. - -**Logfile** -Attach your [klipperscreen.log](https://klipperscreen.readthedocs.io/en/latest/Troubleshooting/) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 00000000..5504ee5d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,54 @@ +name: Bug report +about: Create a report to help us improve +title: "[BUG] " +labels: 'bug' +assignees: '' +body: + - type: markdown + attributes: + value: >- + ## Thank you for choosing KlipperScreen + + #### If you need general support, please visit us on [Discord](https://discord.gg/klipper) + + #### The LOG file is REQUIRED, if you need help to find the log file: + + #### Read the [Documentation](https://klipperscreen.readthedocs.io/en/latest/Troubleshooting/) + + #### This is an Open Source project developed voluntarily, there are no Warranties, or ETA. + #### [License](https://github.com/KlipperScreen/KlipperScreen/blob/master/LICENSE) + + - type: textarea + id: what-happened + attributes: + label: 'What happened?' + description: A clear and concise description of what the bug is. + validations: + required: true + - type: textarea + id: expected-behavior + attributes: + label: 'What did you expect to happen instead?' + description: A clear and concise description of what you expected to happen instead. + validations: + required: true + - type: textarea + id: repro-steps + attributes: + label: 'How to reproduce this bug?' + description: A clear and concise description with precise steps to reproduce this bug. + validations: + required: true + - type: textarea + id: additional-info + attributes: + label: 'Additional information:' + description: Any additional info, screenshots or recordings which help to describe the issue. + - type: textarea + id: logs + attributes: + label: Log output + description: Please copy and paste or attach the klipperscreen.log or xorg.log or the tail of journalctl. + render: shell + validations: + required: true diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..9b6bc36e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +blank_issues_enabled: false +contact_links: + - name: Klipper Discord Server + url: https://discord.gg/klipper + about: If you have questions or need general support. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 9e8ab6a6..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: "[FR]" -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 100644 index 00000000..f48442cd --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,44 @@ +name: Feature request +about: Suggest an idea for this project +title: "[FR] <title>" +labels: '' +assignees: '' +body: + - type: markdown + attributes: + value: >- + ## Thank you for choosing KlipperScreen + + #### This form is for feature request of KlipperScreen + + #### This is an Open Source project developed voluntarily, there are no Warranties, or ETA. + #### [LICENSE](https://github.com/KlipperScreen/KlipperScreen/blob/master/LICENSE) + + - type: textarea + id: solution + attributes: + label: 'Requested feature' + description: A clear and concise description of what you want. + validations: + required: true + - type: textarea + id: what-happened + attributes: + label: 'Is your feature request related to a problem?' + description: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + validations: + required: false + - type: textarea + id: alternative + attributes: + label: 'Describe alternatives you've considered' + description: A clear and concise description of any alternative solutions or features you've considered. + validations: + required: false + - type: textarea + id: info + attributes: + label: 'Additional information' + description: Add any other context drawings or screenshots about the feature. + validations: + required: false