Skip to content

Commit

Permalink
Merge pull request #3 from rajatnai49/issue_templates
Browse files Browse the repository at this point in the history
Add Issue templates
  • Loading branch information
rajatnai49 authored Sep 23, 2023
2 parents 7d53437 + 66eb79e commit 59e693d
Show file tree
Hide file tree
Showing 4 changed files with 239 additions and 0 deletions.
77 changes: 77 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
name: 🪲 Bug Report
description: Report a bug encountered in the project
title: "[Bug]: "

body:
- type: markdown
attributes:
value: |
** Before you submit a bug report, please ensure you have checked the following: **
- [ ] I have searched for similar issues in the project's repository.
- [ ] I have reproduced the issue using the latest version of the project.
- [ ] I have checked the project's documentation and resources for troubleshooting.
# ---------------------------------------------------------------
Thank you for reporting an issue in the project. Please fill out the following information to help us resolve the issue as quickly as possible.
Thank you for taking time to fill out this bug report!
- type: textarea
id: description
attributes:
label: 📝 Description
description: A clear and concise description of what the bug is.
placeholder: Please describe the issue in detail.
value: "Describe your bug here"
validations:
required: true
- type: textarea
id: steps_to_reproduction
attributes:
label: 🪃 Reproduction Steps
description: Steps to reproduce the behavior.
placeholder: Please describe the steps to reproduce the issue.
value: "Steps to reproduce the behavior:"
validations:
required: true
- type: textarea
id: expected_behavior
attributes:
label: 🎯 Expected Behavior
description: A clear and concise description of what you expected to happen.
placeholder: Please describe the expected behavior.
value: "Expected behavior:"
validations:
required: true
- type: textarea
id: actual_behavior
attributes:
label: 🧔🏽‍♀️ Actual Behavior
description: A clear and concise description of what actually happened.
placeholder: Please describe the actual behavior.
value: "Actual behavior:"
validations:
required: true
- type: dropdown
id: contribution
attributes:
label: Select the program in which you are contributing
multiple: true
options:
- HacktoberFest
- Critical
- Minor
- Other
validations:
required: true
- type: markdown
attributes:
value: |
### Related Issue (if any)
- #<issue_number>
- type: checkboxes
id: terms
attributes:
label: I agree to and respect the Code of Conduct
description: By submitting this issue, you are agree to follow our [CODE OF CONDUCT](https://github.com/rajatnai49/demo/blob/main/.github/CODE_OF_CONDUCT.md)
options:
- label: I wil follow [CONTRIBUTING GUIDELINES](https://github.com/rajatnai49/demo/blob/main/.github/CONTRIBUTING_GUIDELINE.md)
required: true
61 changes: 61 additions & 0 deletions .github/ISSUE_TEMPLATE/dataset_analysis_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
name: 📊 Dataset Analysis Request
description: Request data analysis for a provided dataset
title: "[Analysis Request]: "

body:
- type: markdown
attributes:
value: |
Thank you for requesting data analysis on a dataset. Please provide the following information to help us understand your analysis needs.
Your contribution to this project is appreciated!
- type: textarea
id: description
attributes:
label: 📝 Description
description: A clear and concise description of the dataset and the analysis you need.
placeholder: Describe the dataset and your analysis requirements in detail.
value: "Describe the dataset and analysis requirements here"
validations:
required: true
- type: textarea
id: dataset
attributes:
label: 📊 Dataset Details
description: Provide details about the dataset, including its source, format, and any relevant information.
placeholder: Describe the dataset (e.g., source, format, size).
value: "Dataset details here"
validations:
required: true
- type: dropdown
id: analysis_type
attributes:
label: 📈 Analysis Type
description: Select the type of analysis you require.
multiple: true
options:
- HacktoberFest
- Descriptive Statistics
- Data Visualization
- Machine Learning
- Other (please specify in the description)
validations:
required: true
- type: checkboxes
id: code_of_conduct
attributes:
label: I agree to and respect the Code of Conduct
description: By submitting this request, you agree to follow our [CODE OF CONDUCT](https://github.com/rajatnai49/demo/blob/main/.github/CODE_OF_CONDUCT.md)
options:
- label: I will also follow [CONTRIBUTING GUIDELINES](https://github.com/rajatnai49/demo/blob/main/.github/CONTRIBUTING_GUIDELINE.md)
required: true
- type: markdown
attributes:
value: |
### Data Upload
Please upload the dataset file(s) here. If you have multiple files, consider compressing them into a ZIP archive.
### Additional Information
- Deadline (if applicable):
- Any other relevant information:
Thank you for your contribution request!
47 changes: 47 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation_bug.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
name: 📃 Documentation issue report
description: Report an issue in the project's documentation
title: "[Documentation Bug]: "

body:
- type: markdown
attributes:
value: |
Thank you for reporting an issue in the project's documentation. Please fill out the following information to help us resolve the issue as quickly as possible.
Thank you for taking time to fill out this bug report!
- type: textarea
id: description
attributes:
label: 📝 Description
description: A clear and concise description of what the bug is.
placeholder: Please describe the issue in detail.
value: "Describe your bug here"
validations:
required: true
- type: textarea
id: instruction
attributes:
label: 🪃 Instructions to reproduce the issue
description: Please provide a step-by-step instruction to reproduce the issue.
placeholder: Please provide a step-by-step instruction to reproduce the issue.
value: "Steps to reproduce the issue"
validations: true
- type: dropdown
id: contribution
attributes:
label: Select the program in which you are contributing
multiple: true
options:
- HacktoberFest
- Critical
- Minor
- Other
validations:
required: true
- type: checkboxes
id: terms
attributes:
label: I agree to and respect the Code of Conduct
description: By submitting this issue, you are agree to follow our [CODE OF CONDUCT](https://github.com/rajatnai49/demo/blob/main/.github/CODE_OF_CONDUCT.md)
options:
- label: I wil follow [CONTRIBUTING GUIDELINES](https://github.com/rajatnai49/demo/blob/main/.github/CONTRIBUTING_GUIDELINE.md)
required: true
54 changes: 54 additions & 0 deletions .github/ISSUE_TEMPLATE/enhancement.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
name: 💫 Enhancement Request
description: Suggest an enhancement for the project
title: "[Enhancement]: "

body:
- type: markdown
attributes:
value: |
** Before you submit the enhancement request, please ensure you have checked the following: **
- [ ] I have searched for similar enhancement requests in the project's repository.
- [ ] I have checked the project's documentation and resources for troubleshooting.
Thank you for suggesting an enhancement to the project. Please fill out the following information to help us resolve the issue as quickly as possible.
Thank you for taking time to fill out this enhancement request!
- type: textarea
id: description
attributes:
label: 📝 Description
description: A clear and concise description of what the enhancement is.
placeholder: Please describe the enhancement in detail.
value: "Describe your enhancement here"
validations:
required: true
- type: textarea
id: motivation
attributes:
label: 🎯 Motivation
description: A clear and concise description of what the motivation for the enhancement is.
placeholder: Please describe the motivation for the enhancement in detail.
value: "Describe the motivation for the enhancement here"
validations:
required: true
- type: dropdown
id: labels
attributes:
label: Select the labels that best describe this enhancement.
multiple: true
options:
- HacktoberFest
- enhancement
- Other
validations: true
- type: markdown
attributes:
value: |
### Additional information
- [ ] I have attached relevant screenshots or diagrams (if applicable).
- [ ] I have considered potential implementation ideas or solutions.
- [ ] I agree to and respect the project's [Code of Conduct](https://github.com/your_project/repository/blob/main/.github/CODE_OF_CONDUCT.md).
### Related Issue (if any)
Please link to the issue this enhancement request is related to (if any).
Thank you for suggesting this enhancement!

0 comments on commit 59e693d

Please sign in to comment.