Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add issue templates #296

Merged
merged 4 commits into from
Jun 29, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 42 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
name: Bug Report
description: Report any errors or incorrect behaviors to help improve pycytominer.
title: "Bug: "
labels: [bug]

body:
- type: textarea
id: example
attributes:
label: Example code with output
description: >
Please provide the code snippet that is causing the unexpected behavior, along with the corresponding output (if available).
validations:
required: true
- type: textarea
id: problem
attributes:
label: Issue description
description: >
Please provide a written description of the issue as shown in the provided code example.
validations:
required: true
- type: textarea
id: expected-behavior
attributes:
label: Expected behavior
description: >
Please describe and/or show a code example of the expected behavior.
You can also provide an example solution here if available.
validations:
required: true
- type: textarea
id: additional-info
attributes:
label: Additional information
description: >
Please provide any other relevant information to help us understand and fix the bug.
placeholder: >
Examples of other information:
- Screenshots
- Operating system
- pycytominer version
31 changes: 31 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
name: Documentation Request
description: Report missing pycytominer documentation and/or suggest improvements.
title: "Doc: "
labels: [documentation]

body:
- type: textarea
id: doc-location
attributes:
label: File location of the documentation
description: >
Please provide the source of the documentation that this issue is referencing.
placeholder: Example - https://github.com/cytomining/pycytominer/edit/master/docs/index.rst
validations:
require: true
- type: textarea
id: problem
attributes:
label: Documentation issue
description: >
Please provide a description of the missing or outdated documentation that needs to be fixed or updated.
validations:
required: true
- type: textarea
id: suggestion
attributes:
label: Suggested solution
description: >
Please provide your suggestion for what changes should be made in the documentation. If your suggestion involves modifying existing documentation, please explain why the suggested change is an improvement.
validations:
required: true
44 changes: 44 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
name: Feature Request
description: Suggest an idea to enhance the current functionality of pycytominer.
title: "FeatureRequest: "
labels: [enhancement]

body:
- type: checkboxes
id: checks
attributes:
label: Feature type
description: Please select the type of feature you would like to propose.
options:
- label: >
Add new functionality
- label: >
Change existing functionality
- type: textarea
id: description
attributes:
label: General description of the proposed functionality
description: >
Please provide a brief description of the proposed functionality, including whether it addresses an existing issue, and explain how it will enhance pycytominer.
validations:
required: true
- type: textarea
id: feature-example
attributes:
label: Feature example
description: >
Please provide an example of the proposed functionality (e.g., psuedocode).
validations:
required: true
- type: textarea
id: alternative-ideas
attributes:
label: Alternative Solutions
description: >
If applicable, please suggest any alternative solutions/ideas for this functionality.
- type: textarea
id: additional-info
attributes:
label: Additional information
description: >
Provide additional information or context.
21 changes: 21 additions & 0 deletions .github/ISSUE_TEMPLATE/general_questions.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
name: General Questions
description: Provide general questions or feedback regarding pycytominer.
title: "Question: "
labels: [question]

body:
- type: checkboxes
id: checks
attributes:
label: Confirmation
options:
- label: >
I can confirm that this question/issue does not fall under any of the existing three issue types currently available.
- type: textarea
id: question
attributes:
label: General question or description
description: >
Please provide the question or a description of the issue.
validations:
required: true