From 2e7547756f571c8b68de418652cbe40f0d4c0a85 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?H=C3=A5kon=20Wiik=20=C3=85nes?= <hwaanes@gmail.com>
Date: Wed, 8 Jan 2020 22:17:19 +0100
Subject: [PATCH] Update issue and pull request templates
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Signed-off-by: Håkon Wiik Ånes <hwaanes@gmail.com>
---
 .github/ISSUE_TEMPLATE/bug_report.md      | 43 +++++++++++++----------
 .github/ISSUE_TEMPLATE/feature_request.md | 20 +++++------
 .github/PULL_REQUEST_TEMPLATE.md          | 27 --------------
 .github/pull_request_template.md          | 42 ++++++++++++++++++++++
 4 files changed, 74 insertions(+), 58 deletions(-)
 delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md
 create mode 100644 .github/pull_request_template.md

diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
index 891c6177..1929fcaf 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -1,27 +1,32 @@
 ---
 name: Bug report
-about: Create a report to help us improve
-title: ''
-labels: ''
-assignees: ''
-
+about: Create a report to help us improve 
 ---
 
-**Describe the bug**
-A clear and concise description of what the bug is.
+#### Description
+<!-- A clear and concise description of what the bug is. -->
+
+#### Way to reproduce
+
+```python
+>>> import kikuchipy as kp
+>>> import numpy as np
+>>> s = kp.signals.EBSD(np.zeros((10, 10, 10, 10)))
+>>> # The bug here...
+```
 
-**To Reproduce**
-Steps to reproduce the behavior:
-1. Go to '...'
-2. Click on '....'
-3. Scroll down to '....'
-4. See error
+#### Version information
 
-**Expected behavior**
-A clear and concise description of what you expected to happen.
+```python
+# Paste the output of the following python commands
+import sys; print(sys.version)
+import platform; print(platform.platform())
+import kikuchipy; print("kikuchipy version: {}".format(kikuchipy.__version__))
+```
 
-**Screenshots**
-If applicable, add screenshots to help explain your problem.
+```python
+# Your output here
+```
 
-**Additional context**
-Add any other context about the problem here.
+#### Expected behaviour
+<!-- A clear and concise description of what you expected to happen. -->
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
index bbcbbe7d..1e97e6a0 100644
--- a/.github/ISSUE_TEMPLATE/feature_request.md
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -1,20 +1,16 @@
 ---
 name: Feature request
 about: Suggest an idea for this project
-title: ''
-labels: ''
-assignees: ''
-
 ---
 
-**Is your feature request related to a problem? Please describe.**
-A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+#### Is your feature request related to a problem? Please describe.
+<!-- A clear and concise description of what the problem is. -->
 
-**Describe the solution you'd like**
-A clear and concise description of what you want to happen.
+#### Describe the solution you'd like
+<!-- A clear and concise description of what you want to happen. -->
 
-**Describe alternatives you've considered**
-A clear and concise description of any alternative solutions or features you've considered.
+#### 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.
+#### Additional context
+<!-- 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
deleted file mode 100644
index dfe3e51e..00000000
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ /dev/null
@@ -1,27 +0,0 @@
-<!-- Taken from the napari project https://raw.githubusercontent.com/napari/napari/master/.github/PULL_REQUEST_TEMPLATE.md -->
-
-# Description
-<!-- What does this pull request (PR) do? Why is it necessary? -->
-<!-- Tell us about your new feature, improvement, or fix! -->
-
-## Type of change
-<!-- Please delete options that are not relevant. -->
-- [ ] Bug-fix (non-breaking change which fixes an issue)
-- [ ] New feature (non-breaking change which adds functionality)
-- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
-- [ ] This change requires a documentation update
-
-# References
-<!-- What resources, documentation, and guides were used in the creation of this PR? -->
-<!-- If this is a bug-fix or otherwise resolves an issue, reference it here with "closes #(issue)" -->
-
-# How has this been tested?
-<!-- Please describe the tests that you ran to verify your changes. -->
-- [ ] example: the test suite for my feature covers cases x, y, and z
-- [ ] example: all tests pass with my change
-
-## Final checklist:
-- [ ] My PR is the minimum possible work for the desired functionality
-- [ ] I have commented my code, particularly in hard-to-understand areas
-- [ ] I have made corresponding changes to the documentation
-- [ ] I have added tests that prove my fix is effective or that my feature works
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
new file mode 100644
index 00000000..a2960efd
--- /dev/null
+++ b/.github/pull_request_template.md
@@ -0,0 +1,42 @@
+<!-- Requirements -->
+<!-- * Read the contributor guide: https://kikuchipy.readthedocs.io/en/latest/contributing.html -->
+<!-- * Fill out the template. It helps the review process and is useful to summarise the PR. -->
+<!-- * This template can be updated during the progression of the PR to summarise its status -->
+
+#### Description
+<!-- What does this pull request (PR) do? Why is it necessary? -->
+<!-- A few sentences and/or a bullet list. -->
+
+#### Type of change
+<!-- Please delete options that are not relevant. -->
+- [ ] Bug-fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
+- [ ] This change requires a documentation update
+
+#### Progress
+- [ ] Change(s) implemented (can be split into several points)
+- [ ] Docstrings updated (if appropriate)
+- [ ] Code is commented, particularly in hard-to-understand areas (if appropriate)
+- [ ] Documentation and/or user guide updated (if appropriate)
+- [ ] Tests have been written
+- [ ] Ready for review!
+
+#### How has this been tested?
+<!-- Please describe the tests that you ran to verify your changes. -->
+- [ ] example: the test suite for my feature covers cases x, y, and z
+- [ ] example: all tests pass with my change
+
+#### Minimal example of the bug fix or new feature
+<!-- Note that this example can be useful to update the user guide with! -->
+
+```python
+>>> import kikuchipy as kp
+>>> import numpy as np
+>>> s = kp.signals.EBSD(np.zeros((10, 10, 10, 10)))
+>>> # Your new feature...
+```
+
+#### References
+<!-- What resources, documentation, and guides were used in the creation of this PR? -->
+<!-- If this is a bug-fix or otherwise resolves an issue, reference it here with "closes #(issue)" -->