Merge pull request #2928 from jlaehne/issue-template

add new issue templates
hyperspy · Apr 19, 2022 · f79ad12 · f79ad12
2 parents ec67c74 + e250fb3
commit f79ad12
Show file tree

Hide file tree

Showing 4 changed files with 51 additions and 0 deletions.
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,26 @@
+---
+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:
+ - 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
@@ -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
@@ -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.