From a059d80d335795eb0e5e560f4f5c994f6ce6457c Mon Sep 17 00:00:00 2001 From: Ross Goldberg <484615+rgoldberg@users.noreply.github.com> Date: Thu, 21 Nov 2024 08:57:43 -0500 Subject: [PATCH] Replace GitHub Markdown issue templates with GitHub YAML issue forms. Resolve #650 Signed-off-by: Ross Goldberg <484615+rgoldberg@users.noreply.github.com> --- .github/ISSUE_TEMPLATE/01-bug-report.yml | 150 +++++++++++------- .github/ISSUE_TEMPLATE/02-feature-request.yml | 45 ++++-- 2 files changed, 124 insertions(+), 71 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/01-bug-report.yml b/.github/ISSUE_TEMPLATE/01-bug-report.yml index 593335d6..66353931 100644 --- a/.github/ISSUE_TEMPLATE/01-bug-report.yml +++ b/.github/ISSUE_TEMPLATE/01-bug-report.yml @@ -1,58 +1,96 @@ --- -name: Bug report -about: Report a bug -title: '' +name: Bug Report +description: Report a bug. labels: "\U0001F41B bug" -assignees: '' ---- -## Your Environment - -mas version: - -\ - -macOS version: - -\ - -### mas Install Method - -[] `brew install mas` ([Homebrew core](https://github.com/Homebrew/homebrew-core)) - -[] `brew install mas-cli/tap/mas` ([mas Homebrew custom tap](https://github.com/mas-cli/homebrew-tap)) - -[] [mas GitHub Releases](https://github.com/mas-cli/mas/releases) - -- URL of installer: - -[] Built from source - -- git origin URL: \…\> -- git revision: -- git tag/branch: -- Xcode version: - -## Bug Description - -## Steps to Reproduce - -1. - -## Expected Behavior - -## Actual Behavior - -## Shell Output, Screenshots… - -\ - -```shell -$ mas … -… -``` - -\ - -## Additional Context - -\ +body: + - type: input + id: mas-version + attributes: + label: mas version + description: The output of `mas version` + placeholder: ex. 1.8.7 + validations: + required: true + - type: input + id: macos-version + attributes: + label: macOS version + description: The output of `sw_vers -productVersion` + placeholder: ex. 15.1.1 + validations: + required: true + - type: input + id: macos-build + attributes: + label: macOS build version + description: The output of `sw_vers -buildVersion` + placeholder: ex. 24B2091 + validations: + required: true + - type: dropdown + id: install-method + attributes: + label: mas installation method + options: + - Homebrew core (brew install mas) + - Homebrew custom tap (brew install mas-cli/tap/mas) + - GitHub Releases (https://github.com/mas-cli/mas/releases) + - Built from source + - Other + default: 0 + validations: + required: true + - type: textarea + id: install-details + attributes: + label: mas installation details + # yamllint disable rule:trailing-spaces + value: | + + + + + + + + # yamllint enable rule:trailing-spaces + validations: + required: false + - type: textarea + id: expected-behavior + attributes: + label: Expected behavior + placeholder: Prefer copied & pasted commands & output instead of screenshots + validations: + required: true + - type: textarea + id: actual-behavior + attributes: + label: Actual behavior + placeholder: Prefer copied & pasted commands & output instead of screenshots + validations: + required: true + - type: textarea + id: reproduction + attributes: + label: Steps to reproduce + description: | + Provide commands to reproduce the bug in the multiline shell block. Write non-shell steps as comments (`# …`). + value: | + ```shell + + ``` + validations: + required: true + - type: textarea + id: context + attributes: + label: Additional context + placeholder: ex. Does the bug occur in other mas or macOS versions? + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/02-feature-request.yml b/.github/ISSUE_TEMPLATE/02-feature-request.yml index 82fd7df6..f9132a09 100644 --- a/.github/ISSUE_TEMPLATE/02-feature-request.yml +++ b/.github/ISSUE_TEMPLATE/02-feature-request.yml @@ -1,18 +1,33 @@ --- name: Feature request -about: Request a feature -title: '' +description: Request a feature. labels: "\U0001F195 feature request" -assignees: '' ---- -## Problem(s) addressed - -## Proposed solution(s) - -## Alternative solution(s) - -## Additional context - -\ - -\ +body: + - type: textarea + id: problems + attributes: + label: Problem(s) addressed + placeholder: Prefer copied & pasted commands & output instead of screenshots + validations: + required: true + - type: textarea + id: proposals + attributes: + label: Proposed solution(s) + placeholder: Prefer copied & pasted commands & output instead of screenshots + validations: + required: true + - type: textarea + id: alternatives + attributes: + label: Alternative solution(s) + placeholder: Prefer copied & pasted commands & output instead of screenshots + validations: + required: false + - type: textarea + id: context + attributes: + label: Additional context + placeholder: Prefer copied & pasted commands & output instead of screenshots + validations: + required: false