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: Use Issue Forms templates #32157

Merged
merged 13 commits into from
Jun 30, 2021
98 changes: 98 additions & 0 deletions .github/ISSUE_TEMPLATE/BUG_REPORT.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,98 @@
name: Bug Report
description: Something isn't working as expected? Report your bugs here.
labels: "type: bug"
body:
- type: markdown
attributes:
value: |
# Welcome 👋

Thanks for taking the time to fill out this bug report.
Please fill out each section below. This info allows Gatsby maintainers to diagnose (and fix!) your issue as quickly as possible. Otherwise we might need to close the issue without e.g. clear reproduction steps.

Also please verify that your issue is present in `gatsby@next`, too. The `next` version is the latest beta version of Gatsby and has any pending changes that are in the next stable release.

Useful Links:
- Documentation: https://www.gatsbyjs.com/docs/
- How to File an Issue: https://www.gatsbyjs.com/contributing/how-to-file-an-issue/
- type: checkboxes
attributes:
label: Preliminary Checks
description: Please make sure that you verify each checkbox and follow the instructions for them.
options:
- label: "This issue is not a duplicate. Before opening a new issue, please search existing issues: https://github.com/gatsbyjs/gatsby/issues"
required: true
- label: "This issue is not a question, feature request, RFC, or anything other than a bug report. Please post those things in GitHub Discussions: https://github.com/gatsbyjs/gatsby/discussions"
required: true
- type: textarea
attributes:
label: Description
description: Describe the issue that you're seeing.
placeholder: Be as precise as you can. Feel free to share screenshots, videos, or data from the devtools of your browser.
validations:
required: true
- type: input
id: reproduction-link
attributes:
label: Reproduction Link
placeholder: "https://github.com/username/repository-name/"
description: "Link to a reproduction (GitHub repository, Codesandbox, etc.). How to make a minimal reproduction: https://gatsby.dev/reproduction"
validations:
required: true
- type: textarea
attributes:
label: Steps to Reproduce
description: Clear steps describing how to reproduce the issue.
value: |
1.
2.
3.
...
validations:
required: true
- type: textarea
attributes:
label: Expected Result
description: Describe what you expected to happen.
validations:
required: true
- type: textarea
attributes:
label: Actual Result
description: Describe what actually happened.
validations:
required: true
- type: textarea
attributes:
label: Environment
render: shell
description: Run "gatsby info --clipboard" in your project directory and paste the output here.
placeholder: |
You'll get an output similar to this:

System:
OS: Operating System
CPU: CPU
Binaries:
Node: X
npm: X
Languages:
Python: X
Browsers:
Chrome: X
Edge: X
npmPackages:
gatsby: X => X
validations:
required: true
- type: textarea
attributes:
label: Config Flags
description: Do you use any "flags" inside "gatsby-config.js"? If yes, please paste them here.
placeholder: |
For example:

DEV_SSR: true
FAST_DEV: false
validations:
required: false
43 changes: 43 additions & 0 deletions .github/ISSUE_TEMPLATE/DOCUMENTATION.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
name: Documentation
description: Did you find an error in our documentation? Report your findings here.
labels: "type: documentation"
body:
- type: markdown
attributes:
value: |
# Welcome 👋

Thanks for taking the time to fill out this issue.
Please fill out each section below. This info allows Gatsby maintainers to triage and fix your issue as quickly as possible.

Useful links:

- Documentation: https://www.gatsbyjs.com/docs/
- Contributing: https://www.gatsbyjs.com/contributing/
- type: checkboxes
attributes:
label: Preliminary Checks
description: Please make sure that you verify each checkbox and follow the instructions for them.
options:
- label: "This issue is not a duplicate. Before opening a new issue, please search existing issues: https://github.com/gatsbyjs/gatsby/issues"
required: true
- label: "This issue is not a question, feature request, RFC, or anything other than a bug report. Please post those things in GitHub Discussions: https://github.com/gatsbyjs/gatsby/discussions"
required: true
- type: textarea
validations:
required: true
attributes:
label: Summary
description: |
What problem(s) did you run into that caused you to request a fix to the documentation or additional documentation? What questions do you think we should answer?
- type: textarea
validations:
required: true
attributes:
label: Steps to Resolve this Issue
description: How can the problem be solved? Are there any additional steps required? Do any other pages need to be updated?
value: |
1.
2.
3.
...
38 changes: 0 additions & 38 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

43 changes: 0 additions & 43 deletions .github/ISSUE_TEMPLATE/documentation.md

This file was deleted.