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
1 parent
0d74b39
commit 5a98fb4
Showing
4 changed files
with
103 additions
and
0 deletions.
There are no files selected for viewing
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,28 @@ | ||
--- | ||
name: Bug report | ||
about: Report an error or unexpected behavior | ||
title: '' | ||
labels: bug | ||
assignees: '' | ||
|
||
--- | ||
|
||
## Context | ||
Describe what you were attempting to do | ||
|
||
## Minimal Reproducible Example | ||
Provide a (minimal) piece of code that leads to the bug. | ||
Ideally, this piece of code produces the bug every time, | ||
especially in a "fresh" Python session after restart | ||
|
||
## Expected behavior | ||
A clear and concise description of what you expected to happen. | ||
|
||
## Observed behavior | ||
A clear and concise description of the error or unexpected behavior that happens instead. | ||
Attach screenshots if helpful to illustrate. | ||
|
||
## System information: | ||
- OS and version: [e.g. macOS 12, Ubuntu 22.04] | ||
- Python version: [e.g. 3.11] | ||
- stimupy version: [e.g. 1.0.0] |
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: Documentation change | ||
about: Suggest a correction or change to documentation | ||
title: '' | ||
labels: documentation | ||
assignees: '' | ||
|
||
--- | ||
|
||
## Is the proposed change to a specific (function) *docstring*? | ||
If so, please specify which function: [e.g. stimupy.components.shapes.rectangle] | ||
|
||
## Is the proposed change to a specific function *demo*? | ||
If so, please specify which function: [e.g. stimupy.components.shapes.rectangle] | ||
|
||
## Is the proposed change to a specific page? | ||
If so, please specify which page: [e.g., https://stimupy.readthedocs.io/en/latest/index.html] | ||
|
||
## Describe the change | ||
If specific lines/words should be changed, please provide current & new lines, e.g.: | ||
- "this is the old line" | ||
+ "this is the new line" | ||
|
||
If the proposed change/edit/clarification is more general, | ||
please describe. |
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,33 @@ | ||
--- | ||
name: Stimulus request | ||
about: Suggest a stimulus function | ||
title: Add <STIMULUS> | ||
labels: enhancement | ||
assignees: '' | ||
|
||
--- | ||
|
||
## What stimulus would you like? | ||
A clear and concise description of what it should look like. | ||
Please attach images/drawings to illustrate. | ||
If a citation for this stimulus is available, please also mention it. | ||
|
||
## What are the relevant stimulus parameters? | ||
Since `stimupy` stimuli are fully parameterizable, | ||
please briefly describe what parameters you'd like this new function to have, | ||
and what their expected behavior is. | ||
|
||
*NOTE*: if you want only a single parameterization (aside from resolution), | ||
that does not fit within the scope a new stimulus function | ||
-- instead, please request a new stimulus *set*. | ||
|
||
## Is the stimulus is similar to an existing `stimupy` stimulus? | ||
If so, please describe the *differences* between the existing stimulus, | ||
and the proposed one | ||
-- especially the difference in behavior for parameters. | ||
|
||
## Describe alternatives you've considered | ||
A clear and concise description of any alternative solutions or features you've considered. | ||
|
||
## Additional context | ||
Add any other context or screenshots about the feature request here. |
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: Stimulus set request | ||
about: Suggest a stimulus set | ||
title: Add set <CITATION> | ||
labels: enhancement | ||
assignees: '' | ||
|
||
--- | ||
|
||
## What stimulus *set* would you like? | ||
Please provide a DOI / full bibliographical reference to the publication that describes this stimulus set. | ||
|
||
## Are the additional parameters/aspects of the stimuli, not described in the publication? | ||
If so, please share | ||
|
||
## Do you have or know of any implementation of this stimulus set? | ||
If so, please share if possible. |