From 8d918db2367e3d34583e31c6e0b597c54bc01612 Mon Sep 17 00:00:00 2001 From: Adarsh Date: Thu, 22 Feb 2024 21:28:00 +0530 Subject: [PATCH] [feat] Added Issue template to repository --- .github/ISSUE_TEMPLATE/bug_report.yml | 59 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.yml | 39 ++++++++++++++ .gitignore | 3 +- 3 files changed, 100 insertions(+), 1 deletion(-) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..691907f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,59 @@ +name: 🐞 Bug report +description: Create a report to help us improve (use this to report bugs only). +title: "[BUG] " +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" diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..368ba17 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -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" diff --git a/.gitignore b/.gitignore index bb81d77..a05cefe 100644 --- a/.gitignore +++ b/.gitignore @@ -1,5 +1,6 @@ .idea* -.github* +.github/* +!.github/ISSUE_TEMPLATE/ __pycache__/ *.nii.gz bvals.txt