summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJim Lawson2018-02-23 13:44:22 -0800
committerGitHub2018-02-23 13:44:22 -0800
commit01f623d01ccbf038be6124632432e0d9aef84d6e (patch)
tree5b554f1d90d982ee68b451b64a81e711efe86e31
parentb1306ff8af9ede12cc8e49fcdf6ee9550bc194e0 (diff)
Remove checkboxes from issue/pr templates. (#783)
* Remove checkboxes from issue/pr templates. * Compact template text and try to make meta information comments. * Respond to comments - remove bullet point usage.
-rw-r--r--.github/ISSUE_TEMPLATE.md45
-rw-r--r--.github/PULL_REQUEST_TEMPLATE.md27
2 files changed, 35 insertions, 37 deletions
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
index dbc5f2bd..5d7e8ffd 100644
--- a/.github/ISSUE_TEMPLATE.md
+++ b/.github/ISSUE_TEMPLATE.md
@@ -1,30 +1,29 @@
-**Note: for support questions, you are strongly advised to use [Stack Overflow](https://stackoverflow.com/questions/tagged/chisel)**.
-
+<!-- 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.
+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
-* **Type of issue**
- - [ ] Bug report
- - [ ] Feature request
- - [ ] Other enhancement
+<!-- choose one -->
+**Impact**: no functional change | API addition (no impact on existing code) | API modification | unknown
-* **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`
+<!-- choose one -->
+**Development Phase**: request | proposal
-* **What is the use case for changing the behavior?**
+**Other information**
+ <!-- include detailed explanation, stacktraces, related issues, suggestions how to fix, links for us to have context, eg. Stack Overflow, gitter, etc -->
-* **Impact**
- - [ ] no functional change
- - [ ] API addition (no impact on existing code)
- - [ ] API modification
- - [ ] unknown
+**If the current behavior is a bug, please provide the steps to reproduce the problem:**
-* **Development Phase**
- - [ ] request
- - [ ] proposal
+**What is the current behavior?**
-* **Other information** (e.g. detailed explanation, stacktraces, related issues, suggestions how to fix, links for us to have context, eg. Stack Overflow, gitter, etc)
+**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?**
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
index eb460342..d018e685 100644
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,19 +1,18 @@
-* **Related issue** (if applicable)
+<!--
+Please select the item best describing the pull request in each category and delete the other items.
+-->
+**Related issue**: <!-- if applicable -->
-* **Type of change**
- - [ ] Bug report
- - [ ] Feature request
- - [ ] Other enhancement
+<!-- choose one -->
+**Type of change**: bug report | feature request | other enhancement
-* **Impact**
- - [ ] no functional change
- - [ ] API addition (no impact on existing code)
- - [ ] API modification
+<!-- choose one -->
+**Impact**: no functional change | API addition (no impact on existing code) | API modification
-* **Development Phase**
- - [ ] proposal
- - [ ] implementation
-
-* **Release Notes**
+<!-- choose one -->
+**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.
+-->