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

Use the new GitHub issues template #13168

Merged
merged 6 commits into from
Apr 16, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
61 changes: 0 additions & 61 deletions .github/ISSUE_TEMPLATE/Bug_report.md

This file was deleted.

23 changes: 0 additions & 23 deletions .github/ISSUE_TEMPLATE/Feature_request.md

This file was deleted.

108 changes: 108 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,108 @@
name: "🐛 Bug Report"
description: "If something isn't working as expected 🤔."
title: "[Bug]: "
labels: ["i: needs triage"]
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I removed the i: bug label here, since at least half of the "bug reports" we get aren't actual bugs.

body:
- type: markdown
attributes:
value: Thanks for taking the time to file a bug report! Please fill out this form as completely as possible.

- type: checkboxes
attributes:
label: ""
options:
- label: Would you like to work on a fix?

- type: dropdown
attributes:
label: How are you using Babel?
options:
- babel-loader (webpack)
- "@rollup/plugin-babel"
- "@babel/eslint-parser"
- "@babel/cli"
- "@babel/register or @babel/node"
- Programmatic API (`babel.transform`, `babel.parse`)
- Other (Next.js, Gatsby, vue-cli, ...)
validations:
required: true

- type: textarea
attributes:
label: Input code
description: |
You must write here the minimal input code necessary to reproduce the bug.
Even better, you can share a link to the Babel [REPL](https://babel.dev/repl):
this will make it easier for us to reproduce the issue, and it may help fixing
the bug sooner.
If it's not possible to reproduce the bug with a single file, a GitHub Repository
is also ok.
placeholder: |
```js
var your => (code) => here;
```
validations:
required: true

- type: dropdown
attributes:
label: Configuration file name
description: |
**NOTE**: If it's possible that Babel is not correctly loading your config, it's probably because you are using
`.babelrc`/`package.json` instead of `babel.config.json`.
multiple: true
options:
- babel.config.json
- babel.config.js
- babel.config.cjs
- babel.config.mjs
- .babelrc.json
- .babelrc.js
- .babelrc.cjs
- .babelrc.mjs
- .babelrc
- package.json

- type: textarea
attributes:
label: Configuration
description: |
**Tip:** You can also run Babel with the environment variable SHOW_CONFIG_FOR=your_file_path to print all configs associated with a path.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

all these things are really nice!

See https://babeljs.io/docs/en/configuration#print-effective-configs for more information
placeholder: |
```json
{
"your": { "config": "here" }
}
```

- type: textarea
attributes:
label: Current and expected behavior
description: A clear and concise description of what Babel is doing and what you would expect.
validations:
required: true

- type: textarea
attributes:
label: Environment
description: |
**Tip:** you can run `npx envinfo --preset babel` and paste the result below
placeholder: |
- Babel version(s): [e.g. v7.12.0]
- Node: [e.g. Node 15]
- npm/Yarn version: [e.g. npm 7/Yarn 2.3]
- OS: [e.g. macOS 10.15.4, Windows 10]
- Monorepo: [e.g. yes/no/Lerna]
validations:
required: true

- type: textarea
attributes:
label: Possible solution
description: "If you have suggestions on a fix for the bug."

- type: textarea
attributes:
label: Additional context
description: "Add any other context about the problem here. Or a screenshot if applicable."
44 changes: 44 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
name: "🚀 Feature Request"
description: "I have a specific suggestion for Babel!"
title: ""
labels: ["i: needs triage", "i: enhancement"]
body:
- type: markdown
attributes:
value: Thanks for taking the time to suggest a new feature! Please fill out this form as completely as possible.

- type: checkboxes
attributes:
label: ""
description: |
Check this if you would like to implement a PR, we are more than happy to help you go through the process
options:
- label: Would you like to work on this feature?

- type: textarea
attributes:
label: What problem are you trying to solve?
description: |
A concise description of what the problem is.
placeholder: |
I have an issue when [...]
validations:
required: true

- type: textarea
attributes:
label: Describe the solution you'd like
validations:
required: true

- type: textarea
attributes:
label: Describe alternatives you've considered
validations:
required: true

- type: textarea
attributes:
label: Documentation, Adoption, Migration Strategy
description: |
If you can, explain how users will be able to use this and how it might be documented. Maybe a mock-up?