Skip to content

Commit

Permalink
add PR/issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
jlaehne committed Aug 31, 2023
1 parent 732016f commit a7a88d4
Show file tree
Hide file tree
Showing 4 changed files with 82 additions and 0 deletions.
27 changes: 27 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
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.
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/custom.md
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: ''
---


17 changes: 17 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
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.
30 changes: 30 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
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...
```


0 comments on commit a7a88d4

Please sign in to comment.