Skip to content

Commit

Permalink
feat: added issue_templates
Browse files Browse the repository at this point in the history
  • Loading branch information
AngRodrigues authored and rabii-chaarani committed May 27, 2024
1 parent b7385d2 commit dddf70b
Show file tree
Hide file tree
Showing 6 changed files with 255 additions and 58 deletions.
38 changes: 0 additions & 38 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

91 changes: 91 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
name: "Bug Report"
description: "Report a bug or an issue in map2loop"
title: "[Bug] - "
labels: ["bug"]
body:
- type: markdown
attributes:
value: |
## Bug Report
Thanks for submitting a bug report to map2loop!
Please use this template to report a bug. Please provide as much detail as possible to help us reproduce and fix the issue efficiently.
- type: input
id: bug_title
attributes:
label: "Bug Title"
description: "Provide a concise and descriptive title for the bug report."
placeholder: "Enter the title of the bug"
validations:
required: true

- type: textarea
id: bug_description
attributes:
label: "Bug Description"
description: "Describe the bug you encountered. Include details on what you expected to happen and what actually happened."
placeholder: "Enter a detailed description of the bug"
validations:
required: true

- type: textarea
id: steps_to_reproduce
attributes:
label: "Minimal reproducible example"
description: "Provide a minimal reproducible example with the code and data necessary to reproduce the bug."
placeholder: "Enter the steps to reproduce the bug"
validations:
required: true

- type: textarea
id: expected_behavior
attributes:
label: "Expected Behavior"
description: "Describe what you expected to happen."
placeholder: "Enter the expected behavior"
validations:
required: true

- type: textarea
id: actual_behavior
attributes:
label: "Actual Behavior"
description: "Describe what actually happened when you encountered the bug."
placeholder: "Enter the actual behavior"
validations:
required: true

- type: textarea
id: additional_context
attributes:
label: "Additional Context"
description: "Provide any other context or information that may be helpful in understanding and fixing the bug."
placeholder: "Enter any additional context"
validations:
required: false

- type: input
id: environment
attributes:
label: "Environment"
description: "Specify the environment in which the bug occurred (e.g., operating system, browser, application version)."
placeholder: "Enter the environment details"
validations:
required: true

- type: checkboxes
id: severity
attributes:
label: "Severity"
description: "Select the severity level of the bug."
options:
- label: "Low"
value: "low"
- label: "Medium"
value: "medium"
- label: "High"
value: "high"
- label: "Critical"
value: "critical"
validations:
required: true
39 changes: 39 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
name: "Documentation Request"
description: "Help us improve map2loop documentation!"
title: "[Documentation] - "
labels: ["documentation"]
body:
- type: markdown
attributes:
value: |
## Documentation Request
Please use this template to suggest an improvement or addition to map2loop documentation.
Provide as much detail as possible to help us understand and implement your request efficiently.
- type: input
id: doc_title
attributes:
label: "Documentation Title"
description: "Provide a concise and descriptive title for the documentation request."
placeholder: "Enter the title of the documentation request"
validations:
required: true

- type: textarea
id: doc_details
attributes:
label: "Documentation Details"
description: "Describe the documentation you would like to see. Include details on why it is needed and how it should be structured."
placeholder: "Enter a detailed description of the documentation"
validations:
required: true

- type: textarea
id: additional_context
attributes:
label: "Additional Context"
description: "Provide any other context or information that may be helpful."
placeholder: "Enter any additional context"
validations:
required: false
20 changes: 0 additions & 20 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

77 changes: 77 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
name: "Feature Request"
description: "Suggest a new feature or enhancement for map2loop"
title: "[Feature Request] - "
labels: ["enhancement", "feature request"]
body:
- type: markdown
attributes:
value: |
## Feature Request
Please use this template to submit your feature request. Provide as much detail as possible to help us understand and implement your request efficiently.
- type: input
id: feature_title
attributes:
label: "Feature Title"
description: "Provide a concise and descriptive title for the feature request."
placeholder: "Enter the title of the feature"
validations:
required: true

- type: textarea
id: feature_description
attributes:
label: "Feature Description"
description: "Describe the feature you would like to see. Include details on why it is needed and how it should work."
placeholder: "Enter a detailed description of the feature"
validations:
required: true

- type: textarea
id: current_situation
attributes:
label: "Current Situation"
description: "Describe the current situation and how the absence of this feature affects you."
placeholder: "Explain the current situation and its drawbacks"
validations:
required: true

- type: textarea
id: proposed_solution
attributes:
label: "Proposed Solution"
description: "Describe how you envision the feature working. Include any specific requirements or details."
placeholder: "Explain how the feature should work"
validations:
required: true

- type: input
id: additional_context
attributes:
label: "Additional Context"
description: "Provide any other context or information that may be helpful in understanding the feature request."
placeholder: "Enter any additional context"
validations:
required: false

- type: checkboxes
id: affected_areas
attributes:
label: "Affected Areas"
description: "Select the areas of the project that this feature request impacts."
options:
- label: "input data"
value: "input data"
- label: "project creation"
value: "project creation"
- label: "samplers"
value: "samplers"
- label: "sorters"
value: "sorters"
- label: "stratigraphic column"
value: "stratigraphic column"
- label: "data types"
value: "data types"
- label: "Other"
value: "other"
48 changes: 48 additions & 0 deletions .github/ISSUE_TEMPLATE/question.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
name: "Question"
description: "Ask a question about map2loop!"
title: "[Question] - "
labels: ["question"]
body:
- type: markdown
attributes:
value: |
## Question
Please use this template to ask a question about applying map2loop to your data.
Provide as much detail as possible to help us understand and answer your question efficiently.
- type: input
id: question_title
attributes:
label: "Question Title"
description: "Provide a concise and descriptive title for your question."
placeholder: "Enter the title of your question"
validations:
required: true

- type: textarea
id: question_details
attributes:
label: "Question Details"
description: "Describe your question in detail. Include any context or background information that might be helpful."
placeholder: "Enter the details of your question"
validations:
required: true

- type: textarea
id: relevant_code_snippets
attributes:
label: "Relevant code or data"
description: "If applicable, provide any relevant code snippets or examples related to your question."
placeholder: "Enter any relevant code snippets"
validations:
required: false

- type: input
id: additional_context
attributes:
label: "Additional Context"
description: "Provide any other context or information that may be helpful in answering your question."
placeholder: "Enter any additional context"
validations:
required: false

0 comments on commit dddf70b

Please sign in to comment.