diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index a86e04fb..00000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,52 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: "[BUG]: Short descriptive title" -labels: bug -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 bug - -**Expected behavior** -A clear and concise description of what you expected to happen. - -**Screenshots and Videos** -Add screenshots and videos to help explain your problem. - -**Operating System** -Provide the output of `systeminfo | grep "^OS Name\|^OS Version"` - -For example: -``` -OS Name: Microsoft Windows 11 Pro -OS Version: 10.0.22000 N/A Build 22000 -``` - -**`komorebic check` Output** -Provide the output of `komorebic check` - -For example: -``` -No KOMOREBI_CONFIG_HOME detected, defaulting to C:\Users\LGUG2Z - -Looking for configuration files in C:\Users\LGUG2Z - -No komorebi configuration found in C:\Users\LGUG2Z - -If running 'komorebic start --await-configuration', you will manually have to call the following command to begin tiling: komorebic complete-configuration -``` - -**Additional context** -Add any other context about the problem here. - -In particular, if you have any other AHK scripts or software running that handle any aspect of window management or manipulation diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 00000000..84d5f3d7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,56 @@ +name: Bug report +description: File a bug report +labels: [ bug ] +title: "[BUG]: " +body: + - type: textarea + validations: + required: true + attributes: + label: Summary + description: > + Please provide a short summary of the bug, along with any information + you feel is relevant to replicating the bug. + + You may include screenshots and videos in this section. + - type: textarea + validations: + required: true + attributes: + label: Version Information + description: > + Please provide information about the versions of Windows and komorebi + running on your machine. + + Do not submit a bug if you are not using an official version of Windows + such as AtlasOS; only official versions of Windows are supported. + + ``` + systeminfo | findstr /B /C:"OS Name" /B /C:"OS Version" + ``` + + ``` + komorebic --version + ``` + - type: textarea + validations: + required: true + attributes: + label: Komorebi Configuration + description: > + Please provide your configuration file (komorebi.json or komorebi.bar.json) + render: json + - type: textarea + validations: + required: true + attributes: + label: Hotkey Configuration + description: > + Please provide your whkdrc or komorebi.ahk hotkey configuration file + - type: textarea + validations: + required: true + attributes: + label: Output of komorebic check + description: > + Please provide the output of `komorebic check` diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000..195abe59 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,8 @@ +blank_issues_enabled: false +contact_links: + - name: Komorebi Documentation + url: https://lgug2z.github.io/komorebi/ + about: Please search the documentation website before opening an issue + - name: Komorebi Quickstart Tutorial Video + url: https://www.youtube.com/watch?v=MMZUAtHbTYY + about: If you are new, please make sure you watch the quickstart tutorial video \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 91c5647c..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: "[FEAT]: Short descriptive title" -labels: enhancement -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..f3b2cfc8 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,37 @@ +name: Feature request +description: Suggest a new feature +labels: [ enhancement ] +title: "[FEAT]: " +body: + - type: dropdown + id: Sponsors + attributes: + label: Sponsorship Information + description: > + Feature requests are considered from individuals who are $5+ monthly sponsors to the project. + + Please specify the platform you use to sponsor the project. + options: + - GitHub Sponsors + - Ko-fi + - Discord + - YouTube + default: 0 + validations: + required: true + - type: textarea + validations: + required: true + attributes: + label: Suggestion + description: > + Please share your suggestion here. Be sure to include all necessary context. + + If you sponsor on a platform where you use a different username, please specify the username here. + - type: textarea + validations: + required: true + attributes: + label: Alternatives Considered + description: > + Please share share alternatives you have considered here.