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 b822cd7
Show file tree
Hide file tree
Showing 3 changed files with 94 additions and 0 deletions.
64 changes: 64 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
name: Bug report
description: Create a report to help us improve
labels:
- bug
body:
- type: textarea
id: bug_description
attributes:
label: Describe the bug
description: A clear and concise description of what the bug is.
validations:
required: true
- type: textarea
id: version_information
attributes:
label: Version Information
description: |
Please provide the version information of the package you are using.
Use the following command to get the version information:
```bash
node -v && npm list
```
placeholder: |
- Package Version:
- Python Version:
- Operating System:
- type: textarea
id: reproducible_example
attributes:
label: Reproducible Example
description: A short, isolated, but runnable code example is required. **Otherwise, the issue will be closed**.
value: |
```
// Add your code here...
```
render:
rows: 30
validations:
required: true
- 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.
validations:
required: true
- type: textarea
id: actual_behavior
attributes:
label: Actual Behavior
description: Describe what actually happened.
placeholder: A clear and concise description of what actually happened.
validations:
required: true
- type: textarea
id: additional_context
attributes:
label: Additional Context
description: Provide any other context about the problem, like error messages, stack traces, or screenshots. you can also drop a file here.
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 b822cd7

Please sign in to comment.