-
Notifications
You must be signed in to change notification settings - Fork 77
chore: add a structured bug report form #536
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,115 @@ | ||
| name: Bug report | ||
| description: Report a bug or unexpected behavior in gh-stack | ||
| title: "[Bug]: " | ||
| labels: | ||
| - bug | ||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| Thank you for taking the time to report a bug. Please complete the fields below so we can investigate efficiently. | ||
|
|
||
| Before filing, run `gh extension upgrade stack` and confirm the problem still occurs on the latest stable release. | ||
|
|
||
| For security vulnerabilities, follow the instructions in our [security policy](https://github.com/github/gh-stack/security/policy) instead of opening a public issue. | ||
|
|
||
| - type: textarea | ||
| id: description | ||
| attributes: | ||
| label: Describe the bug | ||
| description: Clearly describe what went wrong. | ||
| placeholder: What happened? | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: input | ||
| id: affected-command | ||
| attributes: | ||
| label: Affected command | ||
| description: Which gh-stack command triggered the problem? | ||
| placeholder: gh stack rebase | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: input | ||
| id: gh-stack-version | ||
| attributes: | ||
| label: gh-stack version | ||
| description: Paste the exact output from `gh stack --version`. | ||
| render: shell | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: input | ||
| id: gh-version | ||
| attributes: | ||
| label: GitHub CLI version | ||
| description: Paste the exact output from `gh --version`. | ||
| render: shell | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: input | ||
| id: operating-system | ||
| attributes: | ||
| label: Operating system | ||
| description: Include the operating system and version. | ||
| placeholder: macOS 26.0, Ubuntu 24.04, or Windows 11 | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: input | ||
| id: shell | ||
| attributes: | ||
| label: Shell | ||
| description: Which shell were you using? | ||
| placeholder: zsh, bash, fish, or PowerShell | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| id: steps-to-reproduce | ||
| attributes: | ||
| label: Steps to reproduce | ||
| description: List the commands and steps needed to reproduce the problem. | ||
| placeholder: | | ||
| 1. Run `gh stack ...` | ||
| 2. Select ... | ||
| 3. Observe ... | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| id: expected-behavior | ||
| attributes: | ||
| label: Expected behavior | ||
| description: What did you expect to happen? | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| id: actual-behavior | ||
| attributes: | ||
| label: Actual behavior | ||
| description: What happened instead? | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: textarea | ||
| id: terminal-output | ||
| attributes: | ||
| label: Terminal output | ||
| description: Paste relevant output or write `N/A`. Redact credentials and other sensitive information. | ||
| render: shell | ||
| validations: | ||
| required: true | ||
|
|
||
| - type: checkboxes | ||
| id: preflight | ||
| attributes: | ||
| label: Preflight checks | ||
| options: | ||
| - label: I searched the existing issues for duplicates. | ||
| required: true | ||
| - label: I ran `gh extension upgrade stack` and reproduced this issue on the latest stable release. | ||
| required: true | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🙏