From c5eba28ab23183b23e5d8082c9a822938aa68468 Mon Sep 17 00:00:00 2001 From: Sheri Bigelow Date: Wed, 11 Mar 2020 15:04:49 -0600 Subject: [PATCH 1/9] Simplify the bug report template Fixes https://github.com/Automattic/Simplenote-United/issues/77 Taking inspiration from https://github.com/wordpress-mobile/WordPress-iOS/issues/new let's make our bug report template easier to fill out. Regarding the "Tested on" section, I tried to simplify it but still include hints on all the available options. Does it make sense? Is anything missing? --- .github/ISSUE_TEMPLATE/---bug-report.md | 19 ++++--------------- 1 file changed, 4 insertions(+), 15 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/---bug-report.md b/.github/ISSUE_TEMPLATE/---bug-report.md index d94074d..dc72199 100644 --- a/.github/ISSUE_TEMPLATE/---bug-report.md +++ b/.github/ISSUE_TEMPLATE/---bug-report.md @@ -6,24 +6,13 @@ labels: bug assignees: "" --- -Please, be as descriptive as possible. Issues lacking detail, or for any other reason than to report a bug, may be closed without action. +### Expected behavior -### Expected -***(Required)*** Add a concise description of what you expected. -### Observed -***(Required)*** Add a concise description of what you observed. +### Actual behavior -### Reproduced -***(Required)*** If you cannot reproduce this bug consistently, please elaborate. List the steps to reproduce the behavior. For example: -> 1. Go to... -> 2. Click on... -> 3. See error... -***(Optional)*** If applicable, add screenshots, animations, or videos to help illustrate your problem. +### Steps to reproduce the behavior -***(Required)*** Replace SYSTEM_MAKE, SYSTEM_MODEL, OS_VERSION, and APP_VERSION below with the details for the system running the Simplenote app. If you reproduced the bug on multiple systems, please add a row for each system. -Make|Model|OS Version|App Version --|-|-|- -SYSTEM_MAKE|SYSTEM_MODEL|OS_VERSION|APP_VERSION +##### Tested on [desktop_web_iOS_or_Android], OS [name_and_version], Browser [name_and_version], Simplenote app [version] From 9563c8eb5226b2ca83b3dc8fe819cb22d92377dc Mon Sep 17 00:00:00 2001 From: Sheri Bigelow Date: Thu, 12 Mar 2020 10:39:36 -0600 Subject: [PATCH 2/9] Simplify the bug report template Fixes #77 2nd draft based on feedback from @theck13 in p2XJRt-1Ib-p2. --- .github/ISSUE_TEMPLATE/---bug-report.md | 31 +++++++++++++++++-------- 1 file changed, 21 insertions(+), 10 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/---bug-report.md b/.github/ISSUE_TEMPLATE/---bug-report.md index dc72199..d64fed4 100644 --- a/.github/ISSUE_TEMPLATE/---bug-report.md +++ b/.github/ISSUE_TEMPLATE/---bug-report.md @@ -6,13 +6,24 @@ labels: bug assignees: "" --- -### Expected behavior - - -### Actual behavior - - -### Steps to reproduce the behavior - - -##### Tested on [desktop_web_iOS_or_Android], OS [name_and_version], Browser [name_and_version], Simplenote app [version] +### Screenshots and/or description of expected behavior + + +### Describe what happens instead of the expected behavior + + +### List the steps to reproduce the behavior +1. +2. +3. + +If you cannot reproduce this bug consistently, please elaborate. + +### ***(Required)*** Where you saw the bug happen + +Please list each place where you saw the bug happen and delete the other items from the list. + - OS: Mac, Windows, Linux, iOS, Android, Web + - OS version: + - Browser (if applicable): + - Browser version (if applicable): + - Simplenote app version: From 6f2bed22cbeb6557aeca9ac498df60878382a80c Mon Sep 17 00:00:00 2001 From: Jonathan Belcher Date: Wed, 17 Jun 2020 11:39:35 -0400 Subject: [PATCH 3/9] Small edits --- .github/ISSUE_TEMPLATE/---bug-report.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/.github/ISSUE_TEMPLATE/---bug-report.md b/.github/ISSUE_TEMPLATE/---bug-report.md index d64fed4..4d5aa49 100644 --- a/.github/ISSUE_TEMPLATE/---bug-report.md +++ b/.github/ISSUE_TEMPLATE/---bug-report.md @@ -9,7 +9,7 @@ assignees: "" ### Screenshots and/or description of expected behavior -### Describe what happens instead of the expected behavior +### Screenshots and/or description of observed behavior ### List the steps to reproduce the behavior @@ -18,6 +18,8 @@ assignees: "" 3. If you cannot reproduce this bug consistently, please elaborate. + +If applicable, add screenshots, animations, or videos to help illustrate your problem. ### ***(Required)*** Where you saw the bug happen From e7ef03ddab074d8a1fcea397ee504f2b2fa7b6e7 Mon Sep 17 00:00:00 2001 From: Jonathan Belcher Date: Fri, 19 Jun 2020 15:38:39 -0400 Subject: [PATCH 4/9] Update ---bug-report.md --- .github/ISSUE_TEMPLATE/---bug-report.md | 28 ++++++++++++------------- 1 file changed, 13 insertions(+), 15 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/---bug-report.md b/.github/ISSUE_TEMPLATE/---bug-report.md index 4d5aa49..35e12d6 100644 --- a/.github/ISSUE_TEMPLATE/---bug-report.md +++ b/.github/ISSUE_TEMPLATE/---bug-report.md @@ -6,23 +6,21 @@ labels: bug assignees: "" --- -### Screenshots and/or description of expected behavior - - -### Screenshots and/or description of observed behavior - - -### List the steps to reproduce the behavior -1. -2. -3. - -If you cannot reproduce this bug consistently, please elaborate. +Please, be as descriptive as possible. Issues lacking detail, or for any other reason than to report a bug, may be closed without action. + +### Expected + +### Observed + +### List the steps to reproduce +> 1. Go to... +> 2. Click on... +> 3. See error... If applicable, add screenshots, animations, or videos to help illustrate your problem. - -### ***(Required)*** Where you saw the bug happen - + +### Where did you see the bug + Please list each place where you saw the bug happen and delete the other items from the list. - OS: Mac, Windows, Linux, iOS, Android, Web - OS version: From 3a2e72a528dd47015ea633f7cc378fb5bce6d0b7 Mon Sep 17 00:00:00 2001 From: Jonathan Belcher Date: Fri, 19 Jun 2020 15:47:21 -0400 Subject: [PATCH 5/9] Update ---bug-report.md --- .github/ISSUE_TEMPLATE/---bug-report.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/---bug-report.md b/.github/ISSUE_TEMPLATE/---bug-report.md index 35e12d6..865f265 100644 --- a/.github/ISSUE_TEMPLATE/---bug-report.md +++ b/.github/ISSUE_TEMPLATE/---bug-report.md @@ -21,8 +21,7 @@ If applicable, add screenshots, animations, or videos to help illustrate your pr ### Where did you see the bug -Please list each place where you saw the bug happen and delete the other items from the list. - - OS: Mac, Windows, Linux, iOS, Android, Web + - OS: - OS version: - Browser (if applicable): - Browser version (if applicable): From 55e80fbfb77d098eadc074bbcbfdbd6a80fd02a9 Mon Sep 17 00:00:00 2001 From: Jonathan Belcher Date: Mon, 27 Jul 2020 13:31:23 -0400 Subject: [PATCH 6/9] Update ---bug-report.md --- .github/ISSUE_TEMPLATE/---bug-report.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/---bug-report.md b/.github/ISSUE_TEMPLATE/---bug-report.md index 865f265..dac99a3 100644 --- a/.github/ISSUE_TEMPLATE/---bug-report.md +++ b/.github/ISSUE_TEMPLATE/---bug-report.md @@ -8,11 +8,11 @@ assignees: "" Please, be as descriptive as possible. Issues lacking detail, or for any other reason than to report a bug, may be closed without action. -### Expected +### Expected Functionality (Required) -### Observed +### Observed Functionality (Required) -### List the steps to reproduce +### Steps to reproduce (Required) > 1. Go to... > 2. Click on... > 3. See error... From 93049eb41425066bcc265e50d9913ce51c9a185c Mon Sep 17 00:00:00 2001 From: Jonathan Belcher Date: Mon, 27 Jul 2020 13:45:23 -0400 Subject: [PATCH 7/9] Update ---bug-report.md --- .github/ISSUE_TEMPLATE/---bug-report.md | 25 +++++++++++++++---------- 1 file changed, 15 insertions(+), 10 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/---bug-report.md b/.github/ISSUE_TEMPLATE/---bug-report.md index dac99a3..13217f2 100644 --- a/.github/ISSUE_TEMPLATE/---bug-report.md +++ b/.github/ISSUE_TEMPLATE/---bug-report.md @@ -8,21 +8,26 @@ assignees: "" Please, be as descriptive as possible. Issues lacking detail, or for any other reason than to report a bug, may be closed without action. -### Expected Functionality (Required) +### Expected + -### Observed Functionality (Required) +### Observed + -### Steps to reproduce (Required) +### Reproduced + > 1. Go to... > 2. Click on... > 3. See error... -If applicable, add screenshots, animations, or videos to help illustrate your problem. +***(Optional)*** If applicable, add screenshots, animations, or videos to help illustrate your problem. ### Where did you see the bug - - - OS: - - OS version: - - Browser (if applicable): - - Browser version (if applicable): - - Simplenote app version: + +- System Make: +- System Model: +- OS: +- OS version: +- Browser (if applicable): +- Browser version (if applicable): +- Simplenote app version: From 3f62cba1c3978b5a77c8af8da4cc7cca5a3b0285 Mon Sep 17 00:00:00 2001 From: Jonathan Belcher Date: Mon, 27 Jul 2020 13:47:32 -0400 Subject: [PATCH 8/9] Update ---bug-report.md --- .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 13217f2..f03616f 100644 --- a/.github/ISSUE_TEMPLATE/---bug-report.md +++ b/.github/ISSUE_TEMPLATE/---bug-report.md @@ -6,7 +6,7 @@ labels: bug assignees: "" --- -Please, be as descriptive as possible. Issues lacking detail, or for any other reason than to report a bug, may be closed without action. + ### Expected @@ -20,7 +20,7 @@ Please, be as descriptive as possible. Issues lacking detail, or for any other > 2. Click on... > 3. See error... -***(Optional)*** If applicable, add screenshots, animations, or videos to help illustrate your problem. + ### Where did you see the bug From dd2d6fc4596cc6b3ec41718f03646bbde5f34fa2 Mon Sep 17 00:00:00 2001 From: Jonathan Belcher Date: Mon, 27 Jul 2020 13:50:50 -0400 Subject: [PATCH 9/9] Update ---bug-report.md --- .github/ISSUE_TEMPLATE/---bug-report.md | 14 ++++++++++---- 1 file changed, 10 insertions(+), 4 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/---bug-report.md b/.github/ISSUE_TEMPLATE/---bug-report.md index f03616f..6e4da58 100644 --- a/.github/ISSUE_TEMPLATE/---bug-report.md +++ b/.github/ISSUE_TEMPLATE/---bug-report.md @@ -15,10 +15,16 @@ assignees: "" ### Reproduced - -> 1. Go to... -> 2. Click on... -> 3. See error... + + +1. +2. +3.