diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index a511bc0..0000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,44 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: '' -labels: 'Type: Bug' -assignees: '' ---- - -**Checklist** - - - - -- [ ] I have searched for existing issues -- [ ] I have looked through [the wiki](https://github.com/MonitorControl/MonitorControl/wiki) -- [ ] I have updated MonitorControl to the latest version - -**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. - -**Additional context** -Add any other context about the problem here. - -**Environment Information (please complete the following information):** - -- macOS version: -- Mac model: -- MonitorControl version: -- Monitor(s): -- Apple Silicon/M1 (yes or no): diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..3e779b7 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,73 @@ +name: Bug report +description: Create a report to help us improve +labels: ["Type: Bug"] +assignees: [] +body: + - type: checkboxes + id: checklist + attributes: + label: Before opening the issue, have you...? + description: This is to help us minimize the amount of duplicate issues, which allows us more time for actual development. + options: + - label: Searched for existing issues + required: true + - label: Looked through [the wiki](https://github.com/MonitorControl/MonitorControl/wiki) + required: true + - label: Updated MonitorControl to the latest version (if applicable) + required: true + - type: textarea + id: description + validations: + required: true + attributes: + label: Describe the bug + description: A clear and concise description of what the bug is. + placeholder: "Example: When enabling the Show contrast slider in menu option, the application crashes when clicking on the menu icon." + - type: textarea + id: reproduction + validations: + required: true + attributes: + label: Steps to reproduce + description: Please provide some steps on how we can reproduce the problem. This helps us resolve it faster. + placeholder: | + 1. Go to '...' + 2. Click on '....' + 3. Scroll down to '....' + 4. See error + - type: textarea + id: expected + validations: + required: true + attributes: + label: Expected behavior + description: A clear and concise description of what you expected to happen. + placeholder: "Example: The app shows a contrast slider when clicking the icon in the menu bar and does not crash." + - type: textarea + validations: + required: false + attributes: + label: Anything else? + description: | + Screenshots? Links? References? Anything that will give us more context about the issue you are encountering! + + Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in. + - type: textarea + validations: + required: true + attributes: + label: Environment Information (please complete the following information) + description: | + examples: + - **macOS version**: 11.4 Big Sur + - **Mac model**: MacBook Pro (16-inch, 2019) + - **MonitorControl version**: v2.1.0 + - **Monitor(s)**: LG 38GN950, LG 27UN83A + - **Apple Silicon/M1 (yes or no)**: no + value: | + - macOS version: + - Mac model: + - MonitorControl version: + - Monitor(s): + - Apple Silicon/M1 (yes or no): no + render: markdown diff --git a/.github/ISSUE_TEMPLATE/discussion.md b/.github/ISSUE_TEMPLATE/discussion.md deleted file mode 100644 index 9cb26fa..0000000 --- a/.github/ISSUE_TEMPLATE/discussion.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -name: Discussion -about: I want to discuss something that is related to this project -title: '' -labels: 'Type: Other' -assignees: '' - ---- - -**Checklist** - -- [ ] I have searched for existing issues - -**Discussion** diff --git a/.github/ISSUE_TEMPLATE/discussion.yml b/.github/ISSUE_TEMPLATE/discussion.yml new file mode 100644 index 0000000..60a9c43 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/discussion.yml @@ -0,0 +1,20 @@ +name: Discussion +description: I want to discuss something that is related to this project +labels: ["Type: Other"] +assignees: [] +body: + - type: checkboxes + id: checklist + attributes: + label: Before opening the issue, have you...? + description: This is to help us minimize the amount of duplicate issues, which allows us more time for actual development. + options: + - label: Searched for existing issues + required: true + - type: textarea + id: discussion + validations: + required: true + attributes: + label: Discussion + description: Feel free to type anything you want to discuss related to the project. Do note that we have a seperate template for questions. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index f8dac51..0000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,24 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: '' -labels: 'Type: Feature Request' -assignees: '' - ---- - -**Checklist** - -- [ ] I have searched for existing issues - -**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 0000000..b676edd --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,39 @@ +name: Feature request +description: Suggest an idea for this project +labels: ["Type: Feature Request"] +assignees: [] +body: + - type: checkboxes + attributes: + label: Before opening the issue, have you...? + description: This is to help us minimize the amount of duplicate issues, which allows us more time for actual development. + options: + - label: Searched for existing issues + required: true + - type: textarea + validations: + required: true + attributes: + label: Is your feature request related to a problem? Please describe + description: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + - type: textarea + validations: + required: true + attributes: + label: Describe the solution you'd like + description: A clear and concise description of what you want to happen. + - type: textarea + validations: + required: true + attributes: + label: Describe alternatives you've considered + description: A clear and concise description of any alternative solutions or features you've considered. + - type: textarea + validations: + required: false + attributes: + label: Anything else? + description: | + Screenshots? Links? References? Anything that will give us more context about the issue you are encountering! + + Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in. diff --git a/.github/ISSUE_TEMPLATE/monitor-issue.md b/.github/ISSUE_TEMPLATE/monitor-issue.md deleted file mode 100644 index 5af6291..0000000 --- a/.github/ISSUE_TEMPLATE/monitor-issue.md +++ /dev/null @@ -1,37 +0,0 @@ ---- -name: Monitor Issue -about: MonitorControl is not working as expected on my Monitor -title: '' -labels: 'Type: Monitor Issue' -assignees: '' ---- - -**Checklist** - - - - -- [ ] I have searched for existing issues -- [ ] I have looked through [the Monitor Troubleshooting wiki](https://github.com/MonitorControl/MonitorControl/wiki/Monitor-Troubleshooting) -- [ ] I have updated MonitorControl to the latest version - -**Describe the issue** -A clear and concise description of the problem. - -**Expected behavior** -A clear and concise description of what you expected to happen. - -**Screenshots** -If applicable, add screenshots to help explain your problem. - -**Additional context** -Add any other context about the problem here. - -**Environment Information (please complete the following information):** - -- macOS version: -- MonitorControl version: -- Monitor(s): -- Mac model: -- Monitor Cable(s)/Connection(s): (e.g. DisplayPort) -- Apple Silicon/M1 (yes or no): diff --git a/.github/ISSUE_TEMPLATE/monitor-issue.yml b/.github/ISSUE_TEMPLATE/monitor-issue.yml new file mode 100644 index 0000000..f5619c5 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/monitor-issue.yml @@ -0,0 +1,61 @@ +name: Monitor Issue +description: MonitorControl is not working as expected on my monitor. +labels: ["Type: Monitor Issue"] +assignees: [] +body: + - type: checkboxes + attributes: + label: Before opening the issue, have you...? + description: This is to help us minimize the amount of duplicate issues, which allows us more time for actual development. + options: + - label: Searched for existing issues + required: true + - label: Looked through [the wiki](https://github.com/MonitorControl/MonitorControl/wiki) + required: true + - label: Updated MonitorControl to the latest version (if applicable) + required: true + - type: textarea + validations: + required: true + attributes: + label: Describe the issue + description: A clear and concise description of the problem. + placeholder: Volume & Brightness controls are not working on my LG 38GN950. + - type: textarea + validations: + required: true + attributes: + label: Expected behavior + description: A clear and concise description of what you expected to happen. + - type: textarea + validations: + required: false + attributes: + label: Anything else? + description: | + Screenshots? Links? References? Anything that will give us more context about the issue you are encountering! + + Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in. + - type: textarea + validations: + required: false + attributes: + label: Environment Information (please complete the following information) + description: | + examples: + - **macOS version**: 11.4 Big Sur + - **Mac model**: MacBook Pro (16-inch, 2019) + - **MonitorControl version**: v2.1.0 + - **Monitor(s)**: LG 38GN950, LG 27UN83A + - **Monitor Cable(s)/Connection(s)**: +   - Mac Mini -> DisplayPort 2.1 -> LG 38GN950 +   - Mac Mini -> Belkin Thunderbolt 3 Dock Core -> LG 27UN83A + - **Apple Silicon/M1 (yes or no)**: no + value: | + - macOS version: + - Mac model: + - MonitorControl version: + - Monitor(s): + - Monitor Cable(s)/Connection(s): + - Apple Silicon/M1 (yes or no): + render: markdown diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md deleted file mode 100644 index 644a798..0000000 --- a/.github/ISSUE_TEMPLATE/question.md +++ /dev/null @@ -1,14 +0,0 @@ ---- -name: Question -about: I have a question related to this project -title: '' -labels: 'Type: Question' -assignees: '' - ---- - -**Checklist** - -- [ ] I have searched for existing issues - -**Question** diff --git a/.github/ISSUE_TEMPLATE/question.yml b/.github/ISSUE_TEMPLATE/question.yml new file mode 100644 index 0000000..deeca0c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/question.yml @@ -0,0 +1,18 @@ +name: Question +description: I have a question related to this project +labels: ["Type: Question"] +assignees: [] +body: + - type: checkboxes + attributes: + label: Before opening the issue, have you...? + description: This is to help us minimize the amount of duplicate issues, which allows us more time for actual development. + options: + - label: Searched for existing issues + required: true + - type: textarea + validations: + required: true + attributes: + label: Question + description: Ask your question, be specific. The more info you provide, the easier it will be for someone to answer!