Skip to content

Commit e1b780b

Browse files
francisfuzzCopilotCopilotskarim
authored
chore: add a structured bug report form (#536)
* chore: add structured bug report form Require version, environment, reproduction, and terminal details so maintainers can distinguish current defects from issues already fixed in newer releases. Ask reporters to upgrade and reproduce on the latest stable release before submitting a bug. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * fix: update command in bug report template Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> * fix: s/textarea/input Co-authored-by: Sameen Karim <skarim@github.com> * fix: s/textarea/input Co-authored-by: Sameen Karim <skarim@github.com> --------- Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Co-authored-by: Sameen Karim <skarim@github.com>
1 parent dd03aae commit e1b780b

1 file changed

Lines changed: 115 additions & 0 deletions

File tree

Lines changed: 115 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,115 @@
1+
name: Bug report
2+
description: Report a bug or unexpected behavior in gh-stack
3+
title: "[Bug]: "
4+
labels:
5+
- bug
6+
body:
7+
- type: markdown
8+
attributes:
9+
value: |
10+
Thank you for taking the time to report a bug. Please complete the fields below so we can investigate efficiently.
11+
12+
Before filing, run `gh extension upgrade stack` and confirm the problem still occurs on the latest stable release.
13+
14+
For security vulnerabilities, follow the instructions in our [security policy](https://github.com/github/gh-stack/security/policy) instead of opening a public issue.
15+
16+
- type: textarea
17+
id: description
18+
attributes:
19+
label: Describe the bug
20+
description: Clearly describe what went wrong.
21+
placeholder: What happened?
22+
validations:
23+
required: true
24+
25+
- type: input
26+
id: affected-command
27+
attributes:
28+
label: Affected command
29+
description: Which gh-stack command triggered the problem?
30+
placeholder: gh stack rebase
31+
validations:
32+
required: true
33+
34+
- type: input
35+
id: gh-stack-version
36+
attributes:
37+
label: gh-stack version
38+
description: Paste the exact output from `gh stack --version`.
39+
render: shell
40+
validations:
41+
required: true
42+
43+
- type: input
44+
id: gh-version
45+
attributes:
46+
label: GitHub CLI version
47+
description: Paste the exact output from `gh --version`.
48+
render: shell
49+
validations:
50+
required: true
51+
52+
- type: input
53+
id: operating-system
54+
attributes:
55+
label: Operating system
56+
description: Include the operating system and version.
57+
placeholder: macOS 26.0, Ubuntu 24.04, or Windows 11
58+
validations:
59+
required: true
60+
61+
- type: input
62+
id: shell
63+
attributes:
64+
label: Shell
65+
description: Which shell were you using?
66+
placeholder: zsh, bash, fish, or PowerShell
67+
validations:
68+
required: true
69+
70+
- type: textarea
71+
id: steps-to-reproduce
72+
attributes:
73+
label: Steps to reproduce
74+
description: List the commands and steps needed to reproduce the problem.
75+
placeholder: |
76+
1. Run `gh stack ...`
77+
2. Select ...
78+
3. Observe ...
79+
validations:
80+
required: true
81+
82+
- type: textarea
83+
id: expected-behavior
84+
attributes:
85+
label: Expected behavior
86+
description: What did you expect to happen?
87+
validations:
88+
required: true
89+
90+
- type: textarea
91+
id: actual-behavior
92+
attributes:
93+
label: Actual behavior
94+
description: What happened instead?
95+
validations:
96+
required: true
97+
98+
- type: textarea
99+
id: terminal-output
100+
attributes:
101+
label: Terminal output
102+
description: Paste relevant output or write `N/A`. Redact credentials and other sensitive information.
103+
render: shell
104+
validations:
105+
required: true
106+
107+
- type: checkboxes
108+
id: preflight
109+
attributes:
110+
label: Preflight checks
111+
options:
112+
- label: I searched the existing issues for duplicates.
113+
required: true
114+
- label: I ran `gh extension upgrade stack` and reproduced this issue on the latest stable release.
115+
required: true

0 commit comments

Comments
 (0)