Skip to content

Commit

Permalink
Merge pull request #84 from radical-data/issue-templates
Browse files Browse the repository at this point in the history
Add issue templates
  • Loading branch information
jokroese authored Jul 5, 2024
2 parents f74bd69 + 0356131 commit f613bbd
Show file tree
Hide file tree
Showing 3 changed files with 140 additions and 0 deletions.
84 changes: 84 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
name: 🐞 Bug Report
description: File a bug report to help us improve
title: ''
labels: ['bug', 'triage']
body:
- type: markdown
attributes:
value: |
Thank you for reporting a bug. Please provide the following details to help us fix the issue.
- type: textarea
id: what-happened
attributes:
label: What happened?
description: A clear and concise description of what the bug is.
placeholder: Describe the bug.
validations:
required: true
- type: textarea
id: steps-to-reproduce
attributes:
label: Steps to reproduce the behavior
description: Provide steps to reproduce the behavior.
placeholder: |
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
validations:
required: true
- type: textarea
id: expected-behavior
attributes:
label: Expected behavior
description: A clear and concise description of what you expected to happen.
validations:
required: true
- type: textarea
id: screenshots
attributes:
label: Screenshots
description: If applicable, add screenshots to help explain your problem.
validations:
required: false
- type: checkboxes
id: device-info
attributes:
label: Device Information
description: |
Select the type of device where you encountered the issue. Fill in the corresponding section below.
options:
- label: Desktop
required: false
- label: Smartphone
required: false
- type: textarea
id: desktop-info
attributes:
label: Desktop Information
description: |
Provide as much information as you can. If you're not sure about some details, feel free to leave them out.
- OS: [e.g. iOS]
- Browser [e.g. chrome, safari]
- Version [e.g. 22]
validations:
required: false
- type: textarea
id: smartphone-info
attributes:
label: Smartphone Information
description: |
Provide as much information as you can. If you're not sure about some details, feel free to leave them out.
- Device: [e.g. iPhone6]
- OS: [e.g. iOS8.1]
- Browser [e.g. stock browser, safari]
- Version [e.g. 22]
validations:
required: false
- type: textarea
id: additional-context
attributes:
label: Additional context
description: Add any other context about the problem here.
validations:
required: false
37 changes: 37 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
name: ✨ Feature Request
description: Suggest an idea to improve this project
title: ''
labels: ['enhancement']
body:
- type: markdown
attributes:
value: |
Thank you for suggesting a feature. Please provide the following details to help us understand your request.
- type: textarea
id: related-problem
attributes:
label: Is your feature request related to a problem? Please describe. (Optional)
description: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
validations:
required: false
- type: textarea
id: solution
attributes:
label: Describe the solution you'd like
description: A clear and concise description of what you want to happen.
validations:
required: true
- type: textarea
id: alternatives
attributes:
label: Describe alternatives you've considered (Optional)
description: A clear and concise description of any alternative solutions or features you've considered.
validations:
required: false
- type: textarea
id: additional-context
attributes:
label: Additional context (Optional)
description: Add any other context or screenshots about the feature request here.
validations:
required: false
19 changes: 19 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
name: Pull Request
about: Propose changes to the codebase
title: ''
labels: ''
assignees: ''
---

**Related Issues**

<!-- Include a reference to any related issues. For example, "Closes #123" or "Fixes #123". -->

**Proposed Changes (Optional)**

<!-- Describe the changes proposed in this pull request. Include context and any relevant details about why these changes were made. -->

**Additional context (Optional)**

<!-- Add any other context or information about the pull request here. -->

0 comments on commit f613bbd

Please sign in to comment.