Skip to content

Commit

Permalink
chore: add the bug & feature template
Browse files Browse the repository at this point in the history
  • Loading branch information
karlsbeard committed Aug 26, 2024
1 parent cc13f74 commit 4288539
Show file tree
Hide file tree
Showing 5 changed files with 153 additions and 11 deletions.
90 changes: 90 additions & 0 deletions .github/ISSUE_TEMPLATE/BUG.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@
name: Bug report
description: Report a bug for ts-tree-tools
title: '[BUG]'
labels: [bug]

body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report!
- type: input
id: title
attributes:
label: Bug Title
description: A clear and concise title for the bug
placeholder: Bug title
validations:
required: true

- type: textarea
id: description
attributes:
label: Description
description: A clear and concise description of what the bug is.
placeholder: Describe the bug
validations:
required: true

- type: input
id: version
attributes:
label: Version
description: The version of ts-tree-tools where the bug was found
placeholder: 1.0.0
validations:
required: true

- type: textarea
id: steps
attributes:
label: Steps to Reproduce
description: |
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
placeholder: Steps to reproduce the bug
validations:
required: true

- type: textarea
id: expected
attributes:
label: Expected behavior
description: A clear and concise description of what you expected to happen.
placeholder: Expected behavior
validations:
required: true

- type: textarea
id: actual
attributes:
label: Actual behavior
description: A clear and concise description of what actually happened.
placeholder: Actual behavior
validations:
required: true

- type: textarea
id: logs
attributes:
label: Logs
description: Any relevant logs, error messages, or screenshots.
placeholder: Logs, error messages, or screenshots

- type: dropdown
id: severity
attributes:
label: Severity
description: How severe is the bug?
options:
- Critical
- High
- Medium
- Low
default: 2
validations:
required: true
53 changes: 53 additions & 0 deletions .github/ISSUE_TEMPLATE/FEATURE.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
name: Feature request
description: Suggest a feature for ts-tree-tools
title: '[FEATURE]'
labels: [enhancement]

body:
- type: markdown
attributes:
value: |
Thanks for suggesting a new feature!
- type: input
id: title
attributes:
label: Feature Title
description: A clear and concise title for the feature request
placeholder: Feature title
validations:
required: true

- type: textarea
id: description
attributes:
label: Description
description: A clear and concise description of what the feature is and the problem it solves.
placeholder: Describe the feature
validations:
required: true

- type: textarea
id: motivation
attributes:
label: Motivation
description: Explain why this feature should be added and how it would be useful.
placeholder: Why do you want this feature?
validations:
required: true

- type: textarea
id: alternatives
attributes:
label: Alternatives
description: Describe any alternative solutions or features you've considered.
placeholder: Describe alternative solutions
validations:
required: true

- type: textarea
id: additional
attributes:
label: Additional context
description: Add any other context or screenshots about the feature request here.
placeholder: Additional context
1 change: 1 addition & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
blank_issues_enabled: false
1 change: 0 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,6 @@
"release": "release-it"
},
"dependencies": {
"tree-tool": "^1.1.8"
},
"devDependencies": {
"@antfu/eslint-config": "^2.23.2",
Expand Down
19 changes: 9 additions & 10 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 4288539

Please sign in to comment.