mirror of
https://github.com/oxc-project/oxc.git
synced 2026-09-14 19:36:11 +08:00
connorshea
2b448bd837
Just adding some clarifications, require a 'what happened' section and a version, recommend creating a reproduction repository if possible, add a fuller example config.
And add a link to the Oxc VS Code extension issues for users to be redirected there when relevant.
We can revise this further if desired, maybe we shouldn't include an example config that vaguely works, to avoid reports where people edit the config manually but don't test to ensure it still reproduces the issue? 🤷♂️
56 lines
1.9 KiB
YAML
56 lines
1.9 KiB
YAML
name: Linter bug report
|
|
description: Report a bug in Oxlint
|
|
title: "linter: "
|
|
labels: ["A-linter"]
|
|
type: Bug
|
|
|
|
body:
|
|
- type: markdown
|
|
attributes:
|
|
value: |
|
|
Thanks for helping us improve Oxlint! Please fill out the sections below to help us understand and reproduce the issue you're experiencing.
|
|
|
|
- type: input
|
|
id: version
|
|
attributes:
|
|
label: What version of Oxlint are you using?
|
|
description: You can find the version by running `oxlint -V`. If you ran Oxlint using `npx`, use 'latest'. If you're not sure, please say 'not sure'.
|
|
placeholder: x.y.z
|
|
validations:
|
|
required: true
|
|
|
|
- type: input
|
|
id: command
|
|
attributes:
|
|
label: What command did you run?
|
|
description: Please include the full command with all arguments. If you're not certain (e.g. you're using the VS Code extension), please provide as much detail as possible.
|
|
placeholder: "`oxlint -c .oxlintrc.json`"
|
|
|
|
- type: textarea
|
|
id: config
|
|
attributes:
|
|
label: What does your `.oxlintrc.json` (or `oxlint.config.ts`) config file look like?
|
|
description: If you're not using a config file, please say so. Otherwise please paste its contents here.
|
|
value: |
|
|
```jsonc
|
|
// Replace this with your actual config file contents.
|
|
// It can be helpful to keep it minimal, if possible, but please ensure that it actually reproduces the issue you're reporting.
|
|
{
|
|
"categories": {
|
|
"correctness": "off"
|
|
},
|
|
"plugins": ["react"],
|
|
"rules": {
|
|
"react/whatever-rule": "error"
|
|
}
|
|
}
|
|
```
|
|
|
|
- type: textarea
|
|
id: what-happened
|
|
attributes:
|
|
label: What happened?
|
|
description: Please describe the issue you're experiencing and steps to reproduce the issue. If you have a minimal repository that can be used to reproduce the issue, please link it.
|
|
validations:
|
|
required: true
|