From ab716be22e57ac03a022bc64115fd461a4591736 Mon Sep 17 00:00:00 2001 From: Ross Goldberg <484615+rgoldberg@users.noreply.github.com> Date: Wed, 20 Nov 2024 20:55:56 -0500 Subject: [PATCH] Improve GitHub issue templates. Resolve #630 Signed-off-by: Ross Goldberg <484615+rgoldberg@users.noreply.github.com> --- .github/ISSUE_TEMPLATE/bug_report.md | 64 +++++++++++------------ .github/ISSUE_TEMPLATE/feature_request.md | 18 +++---- 2 files changed, 40 insertions(+), 42 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index d5c00c2..593335d 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,58 +1,58 @@ --- name: Bug report -about: Create a report to help us improve -title: "\U0001F41B [BUG]" +about: Report a bug +title: '' labels: "\U0001F41B bug" assignees: '' - --- - - ## Your Environment -- `mas version`: -- macOS version (`system_profiler SPSoftwareDataType -detailLevel mini`): 10.1... +mas version: + +\ + +macOS version: + +\ ### mas Install Method -- [] `brew install mas` (homebrew-core) -- [] [mas-cli/tap](https://github.com/mas-cli/homebrew-tap) -- [] `.pkg` installer from [releases](https://github.com/mas-cli/mas/releases) -- [] Built from source - - Fork/branch: ? (e.g. mas-cli/main) - - Xcode version: 10.? +[] `brew install mas` ([Homebrew core](https://github.com/Homebrew/homebrew-core)) -## Describe the Bug +[] `brew install mas-cli/tap/mas` ([mas Homebrew custom tap](https://github.com/mas-cli/homebrew-tap)) -> A clear and concise description of what the bug is. +[] [mas GitHub Releases](https://github.com/mas-cli/mas/releases) -## To Reproduce +- URL of installer: -Steps to reproduce the behavior: +[] Built from source -1. Go to '...' -1. Click on '....' -1. Scroll down to '....' -1. See error +- git origin URL: \…\> +- git revision: +- git tag/branch: +- Xcode version: + +## Bug Description + +## Steps to Reproduce + +1. ## Expected Behavior -> A clear and concise description of what you expected to happen. - ## Actual Behavior -> A clear and concise description of what actually happened. +## Shell Output, Screenshots… -## Screenshots, Terminal Output +\ -> If applicable, add screenshots to help explain your problem. - -```bash -$ mas command -... +```shell +$ mas … +… ``` +\ + ## Additional Context -> Add any other context about the problem here. -> Did it work in a previous version? +\ diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index c86fa50..82fd7df 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -1,20 +1,18 @@ --- name: Feature request -about: Suggest an idea for this project +about: Request a feature title: '' labels: "\U0001F195 feature request" assignees: '' - --- +## Problem(s) addressed -**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 [...] +## Proposed solution(s) -**Describe the solution you'd like** -A clear and concise description of what you want to happen. +## Alternative solution(s) -**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. +\ + +\