Skip to content

Commit

Permalink
chore: better templates for filing an issue (#697)
Browse files Browse the repository at this point in the history
  • Loading branch information
ematipico authored Nov 11, 2023
1 parent 79b6571 commit 312d5f2
Show file tree
Hide file tree
Showing 4 changed files with 120 additions and 0 deletions.
60 changes: 60 additions & 0 deletions .github/ISSUE_TEMPLATE/02_lint_bug.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
name: 💅 Lint bug report
description: Report a bug or regression of the linter
title: "💅 <TITLE>"
labels: ["S-To triage"]
body:
- type: markdown
attributes:
value: Thank you for submitting the bug! We'll try to triage it ASAP!
- type: markdown
attributes:
value: |
Bug reports that don't follow this template will be closed.
Please provide a clear and concise description of what the bug is.
- type: textarea
id: environment
attributes:
label: Environment information
description: Run the command `biome rage` and paste its output here. Please review it, in case there are sensitive information you don't want to share.
render: bash
validations:
required: true
- type: input
id: rule-name
attributes:
label: Rule name
description: The name of the rule
validations:
required: true
- type: input
id: playground-link
attributes:
label: Playground link
description: |
Provide a detailed list of steps that reproduce the issue
The more information and included steps, the quicker your report can be triaged and addressed!
You can also use the [playground](https://biomejs.dev/playground/) to share code snippets.
This is useful to reproduce the issue.
If you can't use the playground, use our official [CBS template](https://codesandbox.io/p/sandbox/biome-starter-cbs-rky6zq).
Fork it and share a reproduction.
placeholder: https://biomejs.dev/playground/...
validations:
required: true
- type: textarea
id: expected-result
attributes:
label: Expected result
description: Describe what you expected to happen.
placeholder: It should not throw an error.
validations:
required: true
- type: checkboxes
id: coc
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/biomejs/biome/blob/main/CODE_OF_CONDUCT.md)
options:
- label: I agree to follow Biome's Code of Conduct
required: true
60 changes: 60 additions & 0 deletions .github/ISSUE_TEMPLATE/03_formatter_bug.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
name: 📝 Formatter bug report
description: Report a bug or regression of the formatter
title: "📝 <TITLE>"
labels: ["S-To triage"]
body:
- type: markdown
attributes:
value: Thank you for submitting the bug! We'll try to triage it ASAP!
- type: markdown
attributes:
value: |
Bug reports that don't follow this template will be closed.
Please provide a clear and concise description of what the bug is.
- type: textarea
id: environment
attributes:
label: Environment information
description: Run the command `biome rage` and paste its output here. Please review it, in case there are sensitive information you don't want to share.
render: bash
validations:
required: true
- type: textarea
id: configuration
attributes:
label: Configuration
description: Share the contents of you `biome.json` file
render: JSON
placeholder: |
{
"formatter": {},
"javascript": {
"formatter": {}
}
}
validations:
required: false
- type: input
id: playground-link
attributes:
label: Playground link
description: |
Provide a detailed list of steps that reproduce the issue
The more information and included steps, the quicker your report can be triaged and addressed!
You can also use the [playground](https://biomejs.dev/playground/) to share code snippets.
This is useful to reproduce the issue.
If you can't use the playground, use our official [CBS template](https://codesandbox.io/p/sandbox/biome-starter-cbs-rky6zq).
Fork it and share a reproduction.
placeholder: https://biomejs.dev/playground/...
validations:
required: true
- type: checkboxes
id: coc
attributes:
label: Code of Conduct
description: By submitting this issue, you agree to follow our [Code of Conduct](https://github.com/biomejs/biome/blob/main/CODE_OF_CONDUCT.md)
options:
- label: I agree to follow Biome's Code of Conduct
required: true
File renamed without changes.
File renamed without changes.

0 comments on commit 312d5f2

Please sign in to comment.