From 7d94f7d0953f4f6e6d11cdfbcb3610bc49915ec2 Mon Sep 17 00:00:00 2001 From: LGUG2Z Date: Wed, 9 Oct 2024 20:13:27 -0700 Subject: [PATCH] docs(github): update issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 52 -------------------- .github/ISSUE_TEMPLATE/bug_report.yml | 55 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/config.yml | 5 ++ .github/ISSUE_TEMPLATE/feature_request.md | 20 -------- .github/ISSUE_TEMPLATE/feature_request.yml | 18 +++++++ 5 files changed, 78 insertions(+), 72 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/config.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml 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..f2a23c63 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,55 @@ +name: Bug report +description: File a bug report +labels: [ 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. + + ```powershell + systeminfo | findstr /B /C:"OS Name" /B /C:"OS Version" + ``` + + ``` + komorebic --version + ``` + - type: textarea + validations: + required: true + attributes: + label: configuration + description: > + Please provide your configuration file (komorebi.json or komorebi.bar.json) + render: json + - type: textarea + validations: + required: true + attributes: + label: hotkeys + description: > + Please provide your whkdrc or komorebi.ahk hotkey configuration file + - type: textarea + validations: + required: true + attributes: + label: komorebic check outout + 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..7350ba88 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,5 @@ +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 \ 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..ac488f4e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,18 @@ +name: Feature request +description: Suggest an improvement +labels: [ enhancement ] +body: + - type: textarea + validations: + required: true + attributes: + label: Suggestion + description: > + Please share your suggestion here. Be sure to include all necessary context. + - type: textarea + validations: + required: true + attributes: + label: Alternatives Considered + description: > + Please share share alternatives you have considered here.