From 4d8a2044ffc8802efab633902846b5e1f7dd9b13 Mon Sep 17 00:00:00 2001 From: Iwo Herka Date: Fri, 3 Aug 2018 12:23:52 +0000 Subject: [PATCH] Update issue templates --- .github/ISSUE_TEMPLATE/bug_report.md | 31 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 16 ++++++------ 2 files changed, 39 insertions(+), 8 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..eb08391 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,31 @@ +--- +name: Bug report +about: Create a report to help us improve + +--- + +Provide a general summary of the issue in the title above. + + +## Expected Behavior +Tell us what should happen. + +## Actual Behavior +Tell us what happens instead. + +## Possible Fix +Not obligatory, but you can suggest a fix or reason for the bug. + +## Steps to Reproduce +This is not required, but it would be highly appreciated if you +provided a link to a live example, or an unambiguous set of steps to +reproduce this bug. Include code to reproduce, if relevant. + + +## Your Environment +Include relevant details about the environment you experienced the bug in. + +* Version used: +* Environment name and version (e.g. Django 2.0.4, pip 9.0.1): +* Operating System and version: +* Link to your project (if applicable): diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 066b2d9..57a03c9 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -4,14 +4,14 @@ about: Suggest an idea for this project --- -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] +Provide a general summary of the issue in the title above. -**Describe the solution you'd like** -A clear and concise description of what you want to happen. +## Detailed Description + Provide a description of the change or addition you are proposing. -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. +## Context +Why is this change important to you? How would you use it? +How can it benefit other users? -**Additional context** -Add any other context or screenshots about the feature request here. +## Possible Implementation + Not obligatory, but you may suggest an idea for implementing addition or change.