summaryrefslogtreecommitdiff
path: root/.github
diff options
context:
space:
mode:
authorJim Lawson2017-12-08 13:02:51 -0800
committerGitHub2017-12-08 13:02:51 -0800
commit81fa4f2418faf70b0f2dbf758cad93e923ee5607 (patch)
tree4ec0e0a9e7e429123a977f34177056831f582dc3 /.github
parent30e8eb552a29b22bc23faa06f5661da6129188b2 (diff)
Add issue and pull_request templates. (#713)
* Add issue and pull_request templates. * Scratch itches * Respond to review comments. * Add Stack Overflow link. * Add impact to issue template, type-of-change to pr. * Reorder impact, development phase; add development phase to issue.
Diffstat (limited to '.github')
-rw-r--r--.github/ISSUE_TEMPLATE.md30
-rw-r--r--.github/PULL_REQUEST_TEMPLATE.md19
2 files changed, 49 insertions, 0 deletions
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
new file mode 100644
index 00000000..dbc5f2bd
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE.md
@@ -0,0 +1,30 @@
+**Note: for support questions, you are strongly advised to use [Stack Overflow](https://stackoverflow.com/questions/tagged/chisel)**.
+
+This repository's issues are reserved for feature requests and bug reports.
+
+* **Type of issue**
+ - [ ] Bug report
+ - [ ] Feature request
+ - [ ] Other enhancement
+
+* **If the current behavior is a bug, please provide the steps to reproduce the problem:**
+ * **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`
+
+* **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/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
new file mode 100644
index 00000000..eb460342
--- /dev/null
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -0,0 +1,19 @@
+* **Related issue** (if applicable)
+
+* **Type of change**
+ - [ ] Bug report
+ - [ ] Feature request
+ - [ ] Other enhancement
+
+* **Impact**
+ - [ ] no functional change
+ - [ ] API addition (no impact on existing code)
+ - [ ] API modification
+
+* **Development Phase**
+ - [ ] proposal
+ - [ ] implementation
+
+* **Release Notes**
+
+Text from here to the end of the body will be considered for inclusion in the release notes for the version containing this pull request.