From 29bec1ab153d9c5f16a96bdccc0355c44babc9c2 Mon Sep 17 00:00:00 2001
From: Schuyler Eldridge
Date: Mon, 21 Oct 2019 23:46:16 -0400
Subject: Add separate Issue and PR templates

Signed-off-by: Schuyler Eldridge <schuyler.eldridge@ibm.com>
---
 .github/ISSUE_TEMPLATE.md                 | 24 ---------------------
 .github/ISSUE_TEMPLATE/bug-report.md      | 35 +++++++++++++++++++++++++++++++
 .github/ISSUE_TEMPLATE/feature-request.md | 32 ++++++++++++++++++++++++++++
 .github/PULL_REQUEST_TEMPLATE.md          | 33 +++++++++++++++++++++++++++++
 4 files changed, 100 insertions(+), 24 deletions(-)
 delete mode 100644 .github/ISSUE_TEMPLATE.md
 create mode 100644 .github/ISSUE_TEMPLATE/bug-report.md
 create mode 100644 .github/ISSUE_TEMPLATE/feature-request.md
 create mode 100644 .github/PULL_REQUEST_TEMPLATE.md

(limited to '.github')

diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
deleted file mode 100644
index 8360e59e..00000000
--- a/.github/ISSUE_TEMPLATE.md
+++ /dev/null
@@ -1,24 +0,0 @@
-<!--
-This repository's issues are reserved for feature requests and bug reports.
-Please select the item best describing the issue in each category and delete the other items.
--->
-<!-- choose all that apply -->
-**Type of issue**: bug report | feature request | other enhancement
-
-**If the current behavior is a bug, please provide the steps to reproduce the problem:**
-  * **If possible, please directly provide the FIRRTL file or a relevant fragment if the file is large**
-  * **What is the current behavior?**
-  * **What is the expected behavior?**
-  * **Please tell us about your environment:**
-    (examples)
-    - version: `3.0-SNAPSHOT`
-    - OS: `Linux knight 4.4.0-92-generic #115-Ubuntu SMP Thu Aug 10 09:04:33 UTC 2017 x86_64 x86_64 x86_64 GNU/Linux`
-    - verilator version (if relevant)
-
-**What is the use case for changing the behavior?**
-
-**Impact**: no functional change | API addition (no impact on existing code) | API modification | unknown
-
-**Development Phase**: request | proposal
-
-**Other information** (e.g. detailed explanation, stacktraces, related issues, suggestions how to fix, links for us to have context, eg. Stack Overflow, gitter, etc)
diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md
new file mode 100644
index 00000000..8c41c685
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug-report.md
@@ -0,0 +1,35 @@
+---
+name: Bug Report
+about: Report a problem you experienced with FIRRTL
+labels: improvement=BugFix
+---
+
+### Checklist
+
+- [ ] Did you specify the current behavior?
+- [ ] Did you specify the expected behavior?
+- [ ] Did you provide a code example showing the problem?
+- [ ] Did you describe your environment?
+- [ ] Did you specify relevant external information?
+
+### What is the current behavior?
+
+### What is the expected behavior?
+
+### Steps to Reproduce
+
+<!-- How can someone else reproduce the problem you're seeing? -->
+<!-- It's very helpful to include a full example of a failing Chisel or FIRRTL program! -->
+<!-- Include a stack trace if you have it! -->
+
+### Your environment
+
+<!-- Please tell us a little about your environment -->
+
+- Chisel Verions: <!-- e.g., 3.2.0 -->
+- OS: <!-- e.g., Linux knight 4.4.0-92-generic #115-Ubuntu SMP Thu Aug 10 09:04:33 UTC 2017 x86_64 x86_64 x86_64 GNU/Linux -->
+- Verilator version: <!-- e.g., 4.008 -->
+
+### External Information
+
+<!-- Was this discussed anywhere else, e.g., Twitter, Gitter, StackOverflow? Provide direct links if available! -->
diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md
new file mode 100644
index 00000000..9f84d41d
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature-request.md
@@ -0,0 +1,32 @@
+---
+name: Feature Request
+about: Request a new feature to be added to FIRRTL
+---
+
+### Checklist
+
+- [ ] Did you write out a description of the feature you want to see?
+- [ ] Did you look around for any related features?
+- [ ] Did you specify relevant external information?
+
+### Feature Description
+
+<!-- What type of behavior, API, or feature would you like FIRRTL to have? -->
+
+### Type of Feature
+
+<!-- Choose one or more from the following: -->
+<!--   - performance improvement            -->
+<!--   - documentation                      -->
+<!--   - code refactoring                   -->
+<!--   - code cleanup                       -->
+<!--   - backend code generation            -->
+<!--   - new feature/API                    -->
+
+### Related Features
+
+<!-- Is there anything in the codebase that can do this right now or is substantially related? -->
+
+### External Information
+
+<!-- Was this discussed anywhere else, e.g., Twitter, Gitter, StackOverflow? Provide direct links if available! -->
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
new file mode 100644
index 00000000..9c462b3e
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,33 @@
+### Checklist
+
+- [ ] Did you specify the type of improvement?
+- [ ] Did you state the API impact?
+- [ ] Did you specify the code generation impact?
+- [ ] Did you request a desired merge strategy?
+
+### Type of Improvement
+
+<!-- Choose one or more from the following: -->
+<!--   - bug fix                            -->
+<!--   - performance improvement            -->
+<!--   - documentation                      -->
+<!--   - code refactoring                   -->
+<!--   - code cleanup                       -->
+<!--   - backend code generation            -->
+<!--   - new feature/API                    -->
+
+### API Impact
+
+<!-- How would this affect the current API? Does this add, extend, deprecate, remove, or break any existing API? -->
+
+### Backend Code Generation Impact
+
+<!-- Does this change any generated Verilog?  -->
+<!-- How does it change it or in what circumstances would it?  -->
+
+### Desired Merge Strategy
+
+<!-- If approved, how should this PR be merged? -->
+<!-- Options are: -->
+<!--   - Squash: The PR will be squashed and merged (choose this if you have no preference. -->
+<!--   - Rebase: You will rebase the PR onto master and it will be merged with a merge commit. -->
-- 
cgit v1.2.3