Skip to content

Commit

Permalink
Update issue templates + issue reproduction doc
Browse files Browse the repository at this point in the history
  • Loading branch information
webpro committed Jul 12, 2024
1 parent 349a497 commit d4121d9
Show file tree
Hide file tree
Showing 5 changed files with 82 additions and 51 deletions.
21 changes: 0 additions & 21 deletions .github/ISSUE_TEMPLATE/01-bug_report.md

This file was deleted.

26 changes: 26 additions & 0 deletions .github/ISSUE_TEMPLATE/01-bug_report.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
name: 🐛 Bug report
description: Create a report to help us improve
labels: ['bug']
body:
- type: markdown
attributes:
value: |
Please make sure you have read the docs and are using the latest version of Knip. Use common sense and provide the necessary information that helps me or others to help you.
A minimal reproduction is required: only the code and configuration required to demonstrate the issue.
Please make sure you've read https://knip.dev/guides/issue-reproduction.
- type: input
id: reproduction
attributes:
label: Reproduction url
description: Please link to the location of the issue reproduction
validations:
required: true
- type: textarea
id: description
attributes:
label: Description of the issue
description: What happened, and what would you expect to happen?
validations:
required: true
24 changes: 0 additions & 24 deletions .github/ISSUE_TEMPLATE/02-regression.md

This file was deleted.

40 changes: 40 additions & 0 deletions .github/ISSUE_TEMPLATE/02-regression.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
name: 🐛 Regression
description: Something that worked properly before, but no longer does
labels: ['regression']
body:
- type: markdown
attributes:
value: |
Please make sure you have read the docs and are using the latest version of Knip. Use common sense and provide the necessary information that helps me or others to help you.
A minimal reproduction is required: only the code and configuration required to demonstrate the issue.
Please make sure you've read https://knip.dev/guides/issue-reproduction.
- type: input
id: reproduction
attributes:
label: Reproduction url
description: Please link to the location of the issue reproduction
validations:
required: true
- type: input
id: latest-version
attributes:
label: Reproduction url
description: What's the latest version it worked as expected?
validations:
required: true
- type: input
id: first-version
attributes:
label: Reproduction url
description: What's the first version it no longer works as expected?
validations:
required: true
- type: textarea
id: description
attributes:
label: Description of the regression
description: What happened before, what happens now?
validations:
required: true
22 changes: 16 additions & 6 deletions packages/docs/src/content/docs/guides/issue-reproduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,19 @@ If you encounter an issue or false positives when using Knip, you can [open an
issue on GitHub][1]. This will help you in your project, and will also improve
Knip for everyone else!

Since many factors may influence the issue at hand, in most cases you'll be
asked to provide a minimal reproduction. This contains only the source code and
configuration required to demonstrate the issue. Providing this with a clear
There are many factors that may influence the issue at hand, such as:

- Code syntax, import and export structure in source files
- Dependencies, scripts and entry files in `package.json`
- TypeScript configuration in `tsconfig.json`
- Enabled plugins and configuration files for that tooling
- Dependent or depending workspaces in a monorepo
- Knip configuration in `knip.json`

Think of Knip like a kitchen sink, it handles a large amount of projects and
configurations, and your project is different from all others. That's why it's
required to provide a minimal reproduction. This contains only the source code
and configuration required to demonstrate the issue. Providing this with a clear
issue description will help us help you, and greatly improves the chances your
issue will be looked into efficiently and in a timely manner.

Expand All @@ -20,9 +30,9 @@ source code and configuration is complete and actionable.

Before opening an issue, please make sure you..

- have searched [open issues][1] for the same.
- have checked the list of [known issues][2].
- are using the latest version.
- have searched [open issues][1] for the same,
- have checked the list of [known issues][2],
- are using the latest version,
- have read the documentation.

Please file only a single issue at a time, so each of them can be labeled and
Expand Down

0 comments on commit d4121d9

Please sign in to comment.