Skip to content

Commit

Permalink
chore: create github issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
ShlomoCode committed May 27, 2024
1 parent 3dbbff5 commit 13a5ea6
Show file tree
Hide file tree
Showing 3 changed files with 106 additions and 0 deletions.
76 changes: 76 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
name: Bug report
description: Create a report to help us improve
title: Bug report
labels:
- bug
body:
- type: markdown
attributes:
value: |
**Describe the bug**
A clear and concise description of what the bug is.
- type: textarea
id: bug_description
attributes:
label: Bug Description
description: Provide a clear and concise description of the bug.
placeholder: A clear and concise description of what the bug is.
value: ''
validations:
required: true
- type: markdown
attributes:
value: |
**Reproducible Example**
NOTE! A short, isolated, but runnable code example is required. Preferably by providing a link to [stackblitz](https://stackblitz.com/fork/github/stackblitz/starters/tree/main/node?title=node.new%20Starter&description=Starter%20project%20for%20Node.js%2C%20a%20JavaScript%20runtime%20built%20on%20Chrome%27s%20V8%20JavaScript%20engine). Otherwise, the issue may be closed.
- type: textarea
id: reproducible_example
attributes:
label: Reproducible Example
description: A short, isolated, but runnable code example is required.
placeholder: Provide a link to a reproducible example.
value: ''
validations:
required: true
- type: markdown
attributes:
value: |
**Expected behavior**
A clear and concise description of what you expected to happen.
- type: textarea
id: expected_behavior
attributes:
label: Expected Behavior
description: Describe what you expected to happen.
placeholder: A clear and concise description of what you expected to happen.
value: ''
validations:
required: true
- type: markdown
attributes:
value: |
**Actual behavior**
A clear and concise description of what actually happened.
- type: textarea
id: actual_behavior
attributes:
label: Actual Behavior
description: Describe what actually happened.
placeholder: A clear and concise description of what actually happened.
value: ''
validations:
required: true
- type: markdown
attributes:
value: |
**Additional context**
Add any other context about the problem here.
- type: textarea
id: additional_context
attributes:
label: Additional Context
description: Provide any other context about the problem.
placeholder: Add any other context about the problem here.
value: ''
validations:
required: false
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: enhancement
assignees: ''

---

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here.
10 changes: 10 additions & 0 deletions .github/ISSUE_TEMPLATE/question.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
name: Question
about: Ask a question about library usage
title: ''
labels: question
assignees: ''

---


0 comments on commit 13a5ea6

Please sign in to comment.