From cdd52cde3d3d687a4f9b54576d276057cda7ef54 Mon Sep 17 00:00:00 2001 From: Max Desiatov Date: Wed, 6 Jan 2021 11:15:14 +0000 Subject: [PATCH 1/2] Add a "bug report" issue template We currently receive bug reports that don't always provide a self-contained code sample or screenshots to help us reproduce issues quickly or to add test cases. I hope that this issue template alleviates that. --- .github/ISSUE_TEMPLATE/bug_report.md | 44 ++++++++++++++++++++++++++++ 1 file changed, 44 insertions(+) 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 000000000..3bf1e8da0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,44 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: bug +assignees: MaxDesiatov + +--- + +Replace the placeholders below with details that help us to reproduce the bug. + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +If this is a layout/rendering issue, please provide a self-contained code snippet that reproduces it. + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots** +If this is a layout/rendering issue, please provide screenshots for both Tokamak and SwiftUI that highlight the difference. + +**Desktop (please complete the following information):** + - OS: [e.g. macOS] + - Browser [e.g. chrome, safari] + - Version of the browser [e.g. 22] + - Version of Tokamak [e.g. 0.6.1] + +**Smartphone (please complete the following information):** + - Device: [e.g. iPhone6] + - OS: [e.g. iOS8.1] + - Browser [e.g. stock browser, safari] + - Version of the browser [e.g. 22] + - Version of Tokamak [e.g. 0.6.1] + +**Additional context** +Add any other context about the problem here. From c905b91b1f836989ab373e0c8f2bb2a8ed2f8ef4 Mon Sep 17 00:00:00 2001 From: Max Desiatov Date: Wed, 6 Jan 2021 17:04:30 +0000 Subject: [PATCH 2/2] Apply suggestions from code review Co-authored-by: Jed Fox --- .github/ISSUE_TEMPLATE/bug_report.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 3bf1e8da0..2a6735a7b 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -7,7 +7,7 @@ assignees: MaxDesiatov --- -Replace the placeholders below with details that help us to reproduce the bug. + **Describe the bug** A clear and concise description of what the bug is. @@ -19,7 +19,7 @@ Steps to reproduce the behavior: 3. Scroll down to '....' 4. See error -If this is a layout/rendering issue, please provide a self-contained code snippet that reproduces it. + **Expected behavior** A clear and concise description of what you expected to happen.