From 052239652e060c2036f80463cc349cada8b80427 Mon Sep 17 00:00:00 2001 From: Cory J Slep Date: Tue, 12 Jun 2018 00:25:09 +0200 Subject: [PATCH] Add bug report and feature request templates --- .github/ISSUE_TEMPLATE/bug-report-template.md | 17 +++++++++++++++++ .../ISSUE_TEMPLATE/feature-request-template.md | 16 ++++++++++++++++ 2 files changed, 33 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug-report-template.md create mode 100644 .github/ISSUE_TEMPLATE/feature-request-template.md diff --git a/.github/ISSUE_TEMPLATE/bug-report-template.md b/.github/ISSUE_TEMPLATE/bug-report-template.md new file mode 100644 index 0000000..37d1413 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report-template.md @@ -0,0 +1,17 @@ +--- +name: Bug Report Template +about: "For filing bugs. Please search for existing issues first. Also see CONTRIBUTING." + +--- + +**Please Describe The Problematic Behavior** +(Replace This Text: Please keep descriptions concise. Please include the following so we can assess effort to fix, severity of the defect, and identify root cause: +* How your code uses this library +* What troubleshooting has already been tried +* Any shareable logs of observations +* Resulting impact of the defective behavior + +If your code is open-source, a link to it is also appreciated.) + +**Please Describe The Expected Behavior** +(Replace This Text: Please keep descriptions concise.) diff --git a/.github/ISSUE_TEMPLATE/feature-request-template.md b/.github/ISSUE_TEMPLATE/feature-request-template.md new file mode 100644 index 0000000..830521c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature-request-template.md @@ -0,0 +1,16 @@ +--- +name: Feature Request Template +about: "For feature requests. Please search for existing issues first. Also see CONTRIBUTING." + +--- + +**Please Describe The Problem To Be Solved** +(Replace This Text: Please present a concise description of the problem to be addressed by this feature request. Please be clear what parts of the problem are considered to be in-scope and out-of-scope.) + +**(Optional): Suggest A Solution** +(Replace This Text: A concise description of your preferred solution. Things to address include: +* Details of the technical implementation +* Tradeoffs made in design decisions +* Caveats and considerations for the future + +If there are multiple solutions, please present each one separately. Save comparisons for the very end.)