Skip to content

Commit

Permalink
Replace GitHub Markdown issue templates with GitHub YAML issue forms.
Browse files Browse the repository at this point in the history
Resolve #650

Signed-off-by: Ross Goldberg <[email protected]>
  • Loading branch information
rgoldberg committed Nov 21, 2024
1 parent 3547b32 commit a059d80
Show file tree
Hide file tree
Showing 2 changed files with 124 additions and 71 deletions.
150 changes: 94 additions & 56 deletions .github/ISSUE_TEMPLATE/01-bug-report.yml
Original file line number Diff line number Diff line change
@@ -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:

\<replace this text with the output of `mas version`\>

macOS version:

\<replace this text with the output of `sw_vers`\>

### 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: \<e.g., GitHub fork URL, <https://github.com/mas-cli/mas>…\>
- git revision:
- git tag/branch:
- Xcode version:

## Bug Description

## Steps to Reproduce

1.

## Expected Behavior

## Actual Behavior

## Shell Output, Screenshots…

\<copy & paste shell commands & output below\>

```shell
$ mas <command> …
```

\<attach screenshots only if cannot copy & paste\>

## Additional Context

\<e.g., did the bug occur in previous mas or macOS versions?>
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: |
<!--if you selected the "Other" installation method, provide details below-->
<!--if you installed from GitHub Releases, provide URL of installer below-->
<!--if you built from source, uncomment the following comment & provide all 4 values-->
<!--
- git origin URL:
- git revision:
- git tag/branch:
- Xcode version:
-->
# 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
45 changes: 30 additions & 15 deletions .github/ISSUE_TEMPLATE/02-feature-request.yml
Original file line number Diff line number Diff line change
@@ -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

\<e.g., copied & pasted shell commands & output>

\<e.g., screenshots only if cannot copy & paste>
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

0 comments on commit a059d80

Please sign in to comment.