-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
6 changed files
with
156 additions
and
79 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,82 @@ | ||
name: Bug Report | ||
description: Report a bug or issue with SERD. | ||
title: "[Bug]: " | ||
body: | ||
- type: textarea | ||
id: summary | ||
attributes: | ||
label: Bug summary | ||
description: Concisely describe the encountered bug. | ||
placeholder: Describe the bug in 1-2 short sentences. | ||
value: | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: reproduction | ||
attributes: | ||
label: Code for reproduction | ||
description: | | ||
If possible, please provide a minimum self-contained example. | ||
placeholder: Paste your code here. This field is automatically formatted as Python code. | ||
render: python | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: actual | ||
attributes: | ||
label: Actual outcome | ||
description: | | ||
Paste the output produced by the provided code (e.g., console output, images, screenshots). | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: expected | ||
attributes: | ||
label: Expected outcome | ||
description: Describe what you expected the code to produce. | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: details | ||
attributes: | ||
label: Additional information | ||
description: | | ||
- What are the conditions under which this bug happens? input parameters, edge cases, etc? | ||
- Has this worked in earlier versions? | ||
- Do you know why this bug is happening? | ||
- Do you maybe even know a fix? | ||
- type: input | ||
id: operating-system | ||
attributes: | ||
label: Operating system | ||
description: Specify your operating system (e.g., Ubuntu, OS/X, Windows). | ||
- type: input | ||
id: python-version | ||
attributes: | ||
label: Python version | ||
description: Check your Python version by running `python --version` in the console. | ||
- type: input | ||
id: SERD-version | ||
attributes: | ||
label: SERD Version | ||
description: "From Python prompt: `import SERD; print(SERD.__version__)`" | ||
validations: | ||
required: true | ||
- type: input | ||
id: numpy-version | ||
attributes: | ||
label: Numpy Version | ||
description: "From Python prompt: `import numpy; print(numpy.__version__)`" | ||
- type: input | ||
id: jupyter-version | ||
attributes: | ||
label: Jupyter version | ||
description: "In console: `jupyter notebook --version` or `jupyter lab --version`" | ||
- type: dropdown | ||
id: install | ||
attributes: | ||
label: Installation | ||
description: How did you install SERD? | ||
options: | ||
- pip | ||
- from source |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
name: Documentation | ||
description: Create a report to help us improve the documentation | ||
title: "[Doc]: " | ||
labels: [documentation] | ||
body: | ||
- type: input | ||
id: link | ||
attributes: | ||
label: Documentation Link | ||
description: | | ||
Link to any documentation or examples that you are referencing. | ||
Suggested improvements should be based on the development version of the docs: [SERD Documentation](https://lbc-lnbio.github.io/SERD/) | ||
placeholder: https://lbc-lnbio.github.io/SERD/... | ||
- type: textarea | ||
id: problem | ||
attributes: | ||
label: Problem | ||
description: What is missing, unclear, or wrong in the documentation? | ||
placeholder: | | ||
* I found [...] to be unclear because [...] | ||
* [...] made me think that [...] when really it should be [...] | ||
* There is no example showing how to do [...] | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: improvement | ||
attributes: | ||
label: Suggested improvement | ||
placeholder: | | ||
* This line should be be changed to say [...] | ||
* Include a paragraph explaining [...] | ||
* Add a figure showing [...] |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
name: Feature Request | ||
description: Suggest something to add to SERD! | ||
title: "[ENH]: " | ||
labels: [enhancement] | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
Please search the [issues](https://github.com/LBC-LNBio/SERD/issues) for relevant feature requests before creating a new feature request. | ||
- type: textarea | ||
id: problem | ||
attributes: | ||
label: Problem | ||
description: Briefly describe the problem this feature will solve. (2-4 sentences). | ||
placeholder: | | ||
* I'm always frustrated when [...] because [...] | ||
* I would like it if [...] happened when I [...] because [...] | ||
* Here is a sample image of what I am asking for [...] | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: solution | ||
attributes: | ||
label: Proposed solution | ||
description: Describe a way to accomplish the goals of this feature request. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
name: Maintenance | ||
description: Help improve performance, usability and/or consistency. | ||
title: "[MNT]: " | ||
labels: [enhancement] | ||
body: | ||
- type: textarea | ||
id: summary | ||
attributes: | ||
label: Summary | ||
description: Please provide 1-2 short sentences that succinctly describes what could be improved. | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: fix | ||
attributes: | ||
label: Proposed fix | ||
description: Please describe how you think this could be improved. |