Skip to content

Commit

Permalink
Merge pull request #35 from AdarshRawat1/Dev_Issue_templates
Browse files Browse the repository at this point in the history
[feat] Added Issue template to repository
  • Loading branch information
oliverchampion authored Feb 23, 2024
2 parents 2c4ef83 + f2a6233 commit b77e785
Show file tree
Hide file tree
Showing 3 changed files with 100 additions and 1 deletion.
59 changes: 59 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
name: 🐞 Bug report
description: Create a report to help us improve (use this to report bugs only).
title: "[BUG] <title>"
labels: [🐞 bug]
body:
- type: checkboxes
attributes:
label: Is there an existing issue for this?
description: Please search to see if an issue already exists for the bug you encountered.
options:
- label: I have searched the existing issues
required: true
- type: textarea
attributes:
label: Describe the bug
description: A clear and concise description of what the bug is. Include images if relevant.
placeholder: A bug happened!
validations:
required: true
- type: textarea
attributes:
label: Screenshots [optional]
description: |
Add screenshots to help explain your problem. You can also add a video here.
Tip: You can attach images or video files by clicking this area to highlight it and then dragging files in.
validations:
required: false
- type: textarea
attributes:
label: Steps To Reproduce
description: Steps to reproduce the bug.
placeholder: |
1. Visit '...'
2. Click on '...'
3. Scroll to '...'
4. See error
validations:
required: true
- type: textarea
attributes:
label: Expected behavior
description: A clear and concise description of what you expected to happen
validations:
required: true
- type: textarea
attributes:
label: Additional context
description: |
Links? References? Anything that will give us more context about the issue you are encountering!
validations:
required: false
- type: dropdown
id: assign
attributes:
label: Are you working on this?
options:
- "Yes"
- "No"
39 changes: 39 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
name: ✨ Idea [Feature request]
description: Tell us about the idea you have !
title: "[Feature] <title>"
labels: [idea]
body:
- type: markdown
attributes:
value: |
Your suggestions are highly valuable.
- type: textarea
attributes:
label: Feature description
description: |
Is your feature request related to a problem? A clear and concise description of what the feature is.
validations:
required: true
- type: textarea
attributes:
label: Describe the solution
description: A clear and concise description of what you want to happen.
validations:
required: true
- type: textarea
attributes:
label: Describe alternatives
description: |
A clear and concise description of any alternative solutions or features you have considered.
- type: textarea
attributes:
label: Additional context
description: |
Add any other additional context or screenshots about the feature request here.
- type: dropdown
id: assign
attributes:
label: Are you working on this?
options:
- "Yes"
- "No"
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
.idea*
.github/*
!.github/pull_request_template.md
.github/ISSUE_TEMPLATE/
.github/pull_request_template.md
__pycache__/
*.nii.gz
bvals.txt
Expand Down

0 comments on commit b77e785

Please sign in to comment.