Skip to content

Commit

Permalink
Improve 01-bug-report.yml.
Browse files Browse the repository at this point in the history
Partial #701

Signed-off-by: Ross Goldberg <[email protected]>
  • Loading branch information
rgoldberg committed Jan 4, 2025
1 parent 6f7d6ac commit 893edac
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions .github/ISSUE_TEMPLATE/01-bug-report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ body:
id: config
attributes:
label: mas config
description: The output of `mas config --markdown`
description: Output of `mas config --markdown`
value: |
<!--
If `mas config --markdown` runs without error, replace the contents of this text area with its output.
Expand Down Expand Up @@ -60,7 +60,8 @@ body:
id: reproduction
attributes:
label: Steps to reproduce
description: Copy, paste & format commands & output in the console block (as instructed below)
description: |
Copied, pasted & formatted commands & output in console blocks (as instructed below); instructions; screenshots
value: |
```console
Expand All @@ -78,7 +79,7 @@ body:
Format commands & output as follows (where `…` is a placeholder):
- Use a multiline console block: start with ```` ```console ````, end with ```` ``` ````, each on its own line
- Use a console block: start with ```` ```console ````, end with ```` ``` ````, each on its own line
- Prefix each non-console step (or comment) with two hashes & a space: `## …`
- Remove custom shell prompts; instead, prefix each console command with a dollar sign & a space: `$ …`
- Prefix each output line beginning with `#`, `$`, `%`, or `>` with an additional instance of that <!--
Expand All @@ -89,9 +90,11 @@ body:
````text
```console
## In the Mac App Store GUI, …
## In the Mac App Store GUI, click on
$ mas list
123 App 1 (4.5.6)
124 App 2 (10.2)
$ mas outdated
123 App 1 (4.5.6 -> 4.5.7)
```
````

0 comments on commit 893edac

Please sign in to comment.