Skip to content
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

chore: Update bug issue template. #9438

Merged
merged 1 commit into from
Nov 14, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
57 changes: 18 additions & 39 deletions .github/ISSUE_TEMPLATE/0-turborepo-bug-report.yml
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
name: Turborepo Bug Report
description: Create a bug report for the Turborepo core team
description: Create a bug report
labels: ["kind: bug", "needs: triage"]
title: "🐛 <TITLE>"
body:
- type: markdown
attributes:
value: |
This template is to report Turborepo bugs. Before opening a new issue, please do a [search](https://github.com/vercel/turborepo/issues) of existing issues and :+1: upvote the existing issue instead. This will result in a quicker resolution.
This template is to report bugs. Before opening a new issue, please do a [search](https://github.com/vercel/turborepo/issues) of existing issues and :+1: upvote the existing issue instead. This will result in a quicker resolution.

If you need help with your own project, you can:
- Start a discussion in the ["Help" section](https://github.com/vercel/turborepo/discussions/categories/help).
Expand All @@ -23,34 +24,7 @@ body:
attributes:
label: Link to code that reproduces this issue
description: |
A link to a **public** GitHub repository with a minimal reproduction. Ideally, minimal reproductions should be created using [`npx create-turbo@canary -e with-shell-commands`](https://github.com/vercel/turborepo/tree/main/examples/with-shell-commands) and should include only changes that contribute to the issue. You may also use [`npx create-turbo@canary -e <example-name>`](https://github.com/vercel/turborepo/tree/main/examples) to create a reproduction that includes frameworks if you believe your bug requires a framework to reproduce.
validations:
required: true

- type: dropdown
id: packageManager
attributes:
multiple: true
label: What package manager are you using / does the bug impact?
description: |
You can quickly check different package managers in your reproduction using `npx turbo/workspaces convert`.
options:
- npm
- pnpm
- Yarn v1
- Yarn v2/v3/v4 (node_modules linker only)
validations:
required: true

- type: dropdown
id: os
attributes:
label: What operating system are you using?
options:
- Mac
- Windows
- Linux
- Other
A link to a **public** GitHub repository with a minimal reproduction. Ideally, minimal reproductions should be created using [`npx create-turbo@canary -e with-shell-commands`](https://github.com/vercel/turborepo/tree/main/examples/with-shell-commands) and should include only changes that contribute to the issue. You may also use [`npx create-turbo@canary -e <example-name>`](https://github.com/vercel/turborepo/tree/main/examples) to create a reproduction that includes frameworks if you believe your bug requires a specific framework to reproduce.
validations:
required: true

Expand All @@ -64,40 +38,45 @@ body:

- type: textarea
attributes:
label: Describe the Bug
label: Enviroment information
render: block
description: |
A clear and concise description of the bug.
Run the command `turbo info` and paste its output here. Please review it in case there is sensitive information you don't want to share.

- type: textarea
attributes:
label: Expected behavior
description: |
A clear and concise description of what you expected to happen.
validations:
required: true

- type: textarea
attributes:
label: Expected Behavior
label: Actual behavior
description: |
A clear and concise description of what you expected to happen.
A clear and concise description of the bug.
validations:
required: true

- type: textarea
attributes:
label: To Reproduce
description: |
Steps to reproduce the unexpected behavior. Please provide a clear code snippets that always reproduces the issue or a GitHub repository. Screenshots can be provided in the issue body below.
Steps to reproduce the unexpected behavior. Please provide clear code snippets that always reproduces the issue or a GitHub repository. Screenshots can be provided in "Additional context" below.
validations:
required: true

- type: markdown
attributes:
value: |
Another way you can help the maintainers is to pinpoint the `canary` version of `turbo` that introduced the issue. Check out our [releases](https://github.com/vercel/turborepo/releases), and try to find the first `canary` release that introduced the issue. This will help us narrow down the scope of the issue, and possibly point to the PR/code change that introduced it. You can install a specific version of `turbo` by running `npm install turbo@<version>`.
Another way you can help the maintainers is to pinpoint the `canary` version of `turbo` that introduced the issue. Check out our [releases](https://github.com/vercel/turborepo/releases), and try to find the first `canary` release that introduced the issue. While not required, this will help us narrow down the scope of the issue, and possibly point to the PR/code change that introduced it. You can install a specific version of `turbo` by running `npm install turbo@<version>`.
- type: textarea
attributes:
label: Additional context
description: |
Any extra information that might help us investigate. For example, where are you deploying your application (Vercel, Docker, other platform)? Is it only reproducible on that platform, or locally too? Is the issue only happening in a specific browser? etc.
placeholder: |
I tested my reproduction against different canary releases, and the first one that introduced the bug was "1.10.4-canary.2", since reverting to "1.10.4-canary.1" works.

I tested my reproduction against different canary releases, and the first one that introduced the bug was "2.2.4-canary.2", since reverting to "2.3.4-canary.1" works.
or

I am using GitHub Actions but running my tasks locally does not have the same issue.
Loading