浏览代码

Update issue templates

Improve descriptions
Rob Winch 5 年之前
父节点
当前提交
5eb7134ee0
共有 2 个文件被更改,包括 49 次插入0 次删除
  1. 24 0
      .github/ISSUE_TEMPLATE/bug.md
  2. 25 0
      .github/ISSUE_TEMPLATE/enhancement.md

+ 24 - 0
.github/ISSUE_TEMPLATE/bug.md

@@ -0,0 +1,24 @@
+---
+name: Bug
+about: Create a bug report to help us improve
+title: ''
+labels: 'status: waiting-for-triage, type: bug'
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior.
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Sample**
+
+A link to a GitHub repository with a [minimal, reproducible sample](https://stackoverflow.com/help/minimal-reproducible-example).
+
+Reports that include a sample will take priority over reports that do not.
+At times, we may require a sample, so it is good to try and include a sample up front.

+ 25 - 0
.github/ISSUE_TEMPLATE/enhancement.md

@@ -0,0 +1,25 @@
+---
+name: Enhancement
+about: Suggest an enhancement for this project
+title: ''
+labels: 'status: waiting-for-triage, type: enhancement'
+assignees: ''
+
+---
+
+**Expected Behavior**
+
+<!--- Tell us how it should work -->
+
+**Current Behavior**
+
+<!--- Explain the difference from current behavior -->
+
+**Context**
+
+<!--- 
+How has this issue affected you?
+What are you trying to accomplish?
+What other alternatives have you considered?
+Are you aware of any workarounds?
+-->