-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #8 from jlaehne/templates
Add templates for PRs/issues
- Loading branch information
Showing
4 changed files
with
82 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,27 @@ | ||
--- | ||
name: Bug report | ||
about: Create a report to help us improve | ||
title: '' | ||
labels: 'type: bug' | ||
|
||
--- | ||
|
||
#### Describe the bug | ||
A clear and concise description of what the bug is. | ||
|
||
#### To Reproduce | ||
Steps to reproduce the behavior: | ||
``` | ||
Minimum working example of code | ||
``` | ||
|
||
#### Expected behavior | ||
A clear and concise description of what you expected to happen. | ||
|
||
#### Python environement: | ||
- LumiSpy version: 0.x.x | ||
- HyperSpy version: 1.x.x | ||
- Python version: 3.x | ||
|
||
#### Additional context | ||
Add any other context about the problem here. If necessary, add screenshots to help explain your problem. |
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,8 @@ | ||
--- | ||
name: Custom issue template | ||
about: Describe this issue template's purpose here. | ||
title: '' | ||
labels: '' | ||
--- | ||
|
||
|
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: Feature request | ||
about: Suggest an idea for this project | ||
title: '' | ||
labels: 'type: feature request' | ||
assignees: '' | ||
|
||
--- | ||
|
||
#### Describe the functionality you would like to see. | ||
A clear and concise description of what you would like to do. | ||
|
||
#### Describe the context | ||
Do you want to extend existing functionalities, what types of signals should it apply to, etc. | ||
|
||
#### Additional information | ||
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,30 @@ | ||
### Requirements | ||
* Read the [contributing guidelines](https://github.com/hyperspy/holospy/blob/main/.github/CONTRIBUTING.md). | ||
* Fill out the template; it helps the review process and it is useful to summarise the PR. | ||
* This template can be updated during the progression of the PR to summarise its status. | ||
|
||
*You can delete this section after you read it.* | ||
|
||
### Description of the change | ||
A few sentences and/or a bulleted list to describe and motivate the change: | ||
- Change A. | ||
- Change B. | ||
- etc. | ||
|
||
### Progress of the PR | ||
- [ ] Change implemented (can be split into several points), | ||
- [ ] docstring updated (if appropriate), | ||
- [ ] update user guide (if appropriate), | ||
- [ ] added tests, | ||
- [ ] added line to CHANGES.rst, | ||
- [ ] ready for review. | ||
|
||
### Minimal example of the bug fix or the new feature | ||
```python | ||
import holospy as holo | ||
import numpy as np | ||
s = holo.signals.HologramImage(np.arange(100).reshape(10,10)) | ||
# Your new feature... | ||
``` | ||
|
||
|