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 2 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.
jenna-tomkinson marked this conversation as resolved.
Show resolved Hide resolved
title: "Bug: "
labels: [bug]

body:
- type: textarea
id: example
attributes:
label: Example code with output
description: >
Please provide the code snippet that is producing the unexpected behavior along with the output.
jenna-tomkinson marked this conversation as resolved.
Show resolved Hide resolved
validations:
required: true
- type: textarea
id: problem
attributes:
label: Issue description
description: >
Please provide a written description of the issue as shown in the above code example.
jenna-tomkinson marked this conversation as resolved.
Show resolved Hide resolved
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 you have one.
jenna-tomkinson marked this conversation as resolved.
Show resolved Hide resolved
validations:
required: true
- type: textarea
id: additional-info
attributes:
label: Additional information
description: >
Provide any further information that will help with understanding how to fix this bug.
jenna-tomkinson marked this conversation as resolved.
Show resolved Hide resolved
jenna-tomkinson marked this conversation as resolved.
Show resolved Hide resolved
placeholder: >
Examples of other information:
- Screenshots
- Operating system
- PyCytominer version
jenna-tomkinson marked this conversation as resolved.
Show resolved Hide resolved
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.
jenna-tomkinson marked this conversation as resolved.
Show resolved Hide resolved
title: "Doc: "
labels: [documentation]

body:
- type: textarea
id: doc-location
attributes:
label: File location of the documentation
description: >
Please provide the location of the documentation that this issue is referencing.
jenna-tomkinson marked this conversation as resolved.
Show resolved Hide resolved
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 regarding what documentation is missing or needs to be fixed/updated.
jenna-tomkinson marked this conversation as resolved.
Show resolved Hide resolved
validations:
required: true
- type: textarea
id: suggestion
attributes:
label: Suggested solution
description: >
Please provide your suggestion for what to change in the documentation. If the suggestion involves changing already exisiting documentation, please explain the suggested change is better.
jenna-tomkinson marked this conversation as resolved.
Show resolved Hide resolved
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.
jenna-tomkinson marked this conversation as resolved.
Show resolved Hide resolved
title: "FeatRequest: "
jenna-tomkinson marked this conversation as resolved.
Show resolved Hide resolved
labels: [enhancement]

body:
- type: checkboxes
id: checks
attributes:
label: Feature type
description: Please check the feature type you would like to propose.
jenna-tomkinson marked this conversation as resolved.
Show resolved Hide resolved
options:
- label: >
Add new functionality
- label: >
Change existing functionality
- type: textarea
id: description
attributes:
label: General description of the proposed functionality
description: >
Please *concisely* describe what the proposed functionality is, if it is due to an existing issue, and how it will improve PyCytominer.
jenna-tomkinson marked this conversation as resolved.
Show resolved Hide resolved
validations:
required: true
- type: textarea
id: feature-example
attributes:
label: Feature example
description: >
Please provide an example of this functionality (e.g., psuedocode).
jenna-tomkinson marked this conversation as resolved.
Show resolved Hide resolved
validations:
required: true
- type: textarea
id: alternative-ideas
attributes:
label: Alternative Solutions
description: >
If applicable, please provide any alternative solutions/ideas for this functionality.
jenna-tomkinson marked this conversation as resolved.
Show resolved Hide resolved
- type: textarea
id: additional-info
attributes:
label: Additional information
description: >
Provide any further information or context.
jenna-tomkinson marked this conversation as resolved.
Show resolved Hide resolved
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.
jenna-tomkinson marked this conversation as resolved.
Show resolved Hide resolved
title: "Question: "
labels: [question]

body:
- type: checkboxes
id: checks
attributes:
label: Confirmation
options:
- label: >
I can confirm that this question/issue does not fall within the other three issue types already available
jenna-tomkinson marked this conversation as resolved.
Show resolved Hide resolved
- type: textarea
id: question
attributes:
label: General question or description
description: >
Please provide the question or description of an issue.
jenna-tomkinson marked this conversation as resolved.
Show resolved Hide resolved
validations:
required: true