From a7a88d4a1c89ebb45e7b9ba7449a3465ba7f2a3e Mon Sep 17 00:00:00 2001
From: jlaehne <jonas@pdi-berlin.de>
Date: Thu, 31 Aug 2023 07:22:32 +0200
Subject: [PATCH] add PR/issue templates

---
 .github/ISSUE_TEMPLATE/bug_report.md      | 27 ++++++++++++++++++++
 .github/ISSUE_TEMPLATE/custom.md          |  8 ++++++
 .github/ISSUE_TEMPLATE/feature_request.md | 17 +++++++++++++
 .github/PULL_REQUEST_TEMPLATE.md          | 30 +++++++++++++++++++++++
 4 files changed, 82 insertions(+)
 create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md
 create mode 100644 .github/ISSUE_TEMPLATE/custom.md
 create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md
 create mode 100755 .github/PULL_REQUEST_TEMPLATE.md

diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
new file mode 100644
index 0000000..4bf7133
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -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.
diff --git a/.github/ISSUE_TEMPLATE/custom.md b/.github/ISSUE_TEMPLATE/custom.md
new file mode 100644
index 0000000..bdd4f85
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/custom.md
@@ -0,0 +1,8 @@
+---
+name: Custom issue template
+about: Describe this issue template's purpose here.
+title: ''
+labels: ''
+---
+
+
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
new file mode 100644
index 0000000..3f681fa
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -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.
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
new file mode 100755
index 0000000..4d4d5bb
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -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...
+```
+
+