From 14584fac7ad1991f25cfed02dd29e92d9e7180a1 Mon Sep 17 00:00:00 2001
From: Johannes <brycx@protonmail.com>
Date: Sat, 26 Dec 2020 11:13:49 +0100
Subject: [PATCH] Add templates for bug reports and feature requests (#155)

* Add bug report template

* Add feature request template

* Update CONTRIBUTING
---
 .github/ISSUE_TEMPLATE/bug_report.md      | 34 +++++++++++++++++++++++
 .github/ISSUE_TEMPLATE/feature_request.md | 20 +++++++++++++
 CONTRIBUTING.md                           | 28 ++++---------------
 3 files changed, 60 insertions(+), 22 deletions(-)
 create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md
 create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md

diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
new file mode 100644
index 00000000..1a88010a
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,34 @@
+---
+name: Bug report
+about: Create a bug report to help us improve
+title: ''
+labels: bug
+assignees: ''
+---
+
+**Description**
+A clear and concise description of what the bug is.
+
+**Steps to reproduce**
+Steps to reproduce the behavior.
+
+```rust
+// Add relevant code-snippets here...
+
+
+
+```
+
+**Expected result**
+The expected result.
+
+**Actual result**
+The actual result.
+
+
+**Additional information**
+This is not required, but can be very helpful when trying to find the root cause. It may include other things as well, not only the things listed below. 
+
+- Orion features selected: `default-features = false`, default, `alloc`, etc
+- Orion version: `v0.10.0`, `master`, etc
+- Rust version: `$ rustc -V`
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
new file mode 100644
index 00000000..d3405d08
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -0,0 +1,20 @@
+---
+name: Feature Request
+about: Suggest a new idea for the project
+labels: new feature
+---
+
+**Summary**
+Brief explanation of the feature.
+
+**Basic example**
+If the proposal involves a new or changed API, include a basic code example. Omit this section if it's not applicable.
+
+```rust
+// Add relevant code-snippets here...
+
+
+```
+
+**Motivation**
+Why are we doing this? What use cases does it support? Will it be used anywhere?
\ No newline at end of file
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index d6f62228..7b5345df 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -25,29 +25,17 @@ Quality of documentation is a vital part of this project. Contributions to this
 
 Try to make changes adhere to the [Rust API Guidelines](https://rust-lang-nursery.github.io/api-guidelines/checklist.html) as much as possible.
 
-### 2. Bug Reports
-A bug report should _ideally_ include all the information in this template:
+### 2. Bug Reports and Feature Requests
+There are templates for both these scenarios, please see the `.github/ISSUE_TEMPLATE/` directory.
 
-```
-Brief description:
-
-Steps to reproduce:
-
-Expected result:
-
-Actual result:
-
-Additional information:
-    - Rust version ($ rustc -V)
-    - orion version
-```
-
-Bug reports don't need to strictly follow this template but in most cases, more information about the bug makes it easier to analyze and fix.
+A bug report or feature request should _ideally_ follow the provided templates. It's not a strict requirement but in most cases, more information about the bug or feature makes it easier to fix/evaluate.
 
 ### 3. Pull Requests
 
 Before submitting a pull request, please make sure you have done the following:
 
+- [ ] Explain what the pull request changes, in the description of the GitHub PR, or link to the relevant issue.
+
 - [ ] A change or addition of functionality is covered by unit-tests.
 
 - [ ] Ensure that all tests pass when running:
@@ -60,12 +48,8 @@ Before submitting a pull request, please make sure you have done the following:
   - `cargo clippy`
   - `cargo fmt`
 
-- [ ] Explain what the pull request changes, in the description of the GitHub PR.
 - [ ] If the pull request is a bugfix, try to include a regression test for the bug.
 
 All pull requests should be opened against the `master` branch.
 
-If your pull request is still work-in-progress, make the title of the pull request start with `[WIP]`.
-
-### 4. Feature Requests
-A request for a new feature should be started in a GitHub issue. This issue should explain what feature is requested, why it is requested and, if applicable, the use-case behind it.
\ No newline at end of file
+If your pull request is still work-in-progress, make the title of the pull request start with `WIP:`.
\ No newline at end of file