Skip to content

Commit

Permalink
docs: create issue template. Closes #10
Browse files Browse the repository at this point in the history
  • Loading branch information
mattlewis92 committed Nov 3, 2023
1 parent 9a55e34 commit f60e0fa
Show file tree
Hide file tree
Showing 3 changed files with 102 additions and 0 deletions.
66 changes: 66 additions & 0 deletions .github/ISSUE_TEMPLATE/1-bug-report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
name: Bug report
description: Report a bug
body:
- type: markdown
attributes:
value: |
Oh hi there!
To expedite issue processing please search open and closed issues before submitting a new one.
Existing issues often contain information about workarounds, resolution, or progress updates.
- type: checkboxes
id: is-regression
attributes:
label: Is this a regression?
description: Did this behavior use to work in the previous version?
options:
- label: Yes, this behavior used to work in the previous version
- type: input
id: version-bug-was-not-present
attributes:
label: The previous version in which this bug was not present was
validations:
required: false
- type: textarea
id: description
attributes:
label: Description
description: A clear and concise description of the problem.
validations:
required: true
- type: textarea
id: minimal-reproduction
attributes:
label: Minimal Reproduction
description: |
Simple steps to reproduce this bug.
**Please include:**
* commands run (including args)
* packages added
* related code changes
If reproduction steps are not enough for reproduction of your issue, please create a minimal GitHub repository with the reproduction of the issue.
A good way to make a minimal reproduction is to create a new app and add the minimum possible code to show the problem.
Share the link to the repo below along with step-by-step instructions to reproduce the problem, as well as expected and actual behavior.
Issues that don't have enough info and can't be reproduced will be closed.
validations:
required: true
- type: textarea
id: exception-or-error
attributes:
label: Exception or Error
description: If the issue is accompanied by an exception or an error, please share it below.
render: text
validations:
required: false
- type: textarea
id: other
attributes:
label: Anything else relevant?
description: |
Do any of these matter: operating system, IDE, package manager, HTTP server, ...? If so, please mention it below.
validations:
required: false
31 changes: 31 additions & 0 deletions .github/ISSUE_TEMPLATE/2-feature-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
name: Feature request
description: Suggest a feature
body:
- type: markdown
attributes:
value: |
Oh hi there!
To expedite issue processing please search open and closed issues before submitting a new one.
Existing issues often contain information about workarounds, resolution, or progress updates.
- type: textarea
id: description
attributes:
label: Description
description: A clear and concise description of the problem or missing capability.
validations:
required: true
- type: textarea
id: desired-solution
attributes:
label: Describe the solution you'd like
description: If you have a solution in mind, please describe it.
validations:
required: false
- type: textarea
id: alternatives
attributes:
label: Describe alternatives you've considered
description: Have you considered any alternative solutions or workarounds?
validations:
required: false
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: Support request
url: https://github.com/clickup/ngx-esbuild/discussions
about: Questions and requests for support.

0 comments on commit f60e0fa

Please sign in to comment.