From c959321ab08a8fdff6994d198053090a62b255b6 Mon Sep 17 00:00:00 2001 From: Josephine Lim Date: Wed, 2 May 2018 20:17:32 +1000 Subject: [PATCH 1/2] Update issue_template.md It feels like the template for reporting bugs is a bit redundant - we have summary, steps to reproduce, observed behaviour AND expected behaviour, which all are very similar. I think that by paring it down to the essentials, people will be less likely to skip steps. --- ISSUE_TEMPLATE.md | 14 +++----------- 1 file changed, 3 insertions(+), 11 deletions(-) diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md index 691562b04..ce33f1a18 100644 --- a/ISSUE_TEMPLATE.md +++ b/ISSUE_TEMPLATE.md @@ -1,9 +1,9 @@ -_Before creating an issue, please search the existing issues to see if a similar one has already been created. You can search issues by specific labels (e.g. `label:nearby `) or just by typing keywords into the search filter._ - **Summary:** Summarize your issue in one sentence (what goes wrong, what did you expect to happen) +_Before creating an issue, please search the existing issues to see if a similar one has already been created. You can search issues by specific labels (e.g. `label:nearby `) or just by typing keywords into the search filter._ + **Steps to reproduce:** How can we reproduce the issue? @@ -12,14 +12,6 @@ How can we reproduce the issue? Add logcat files here (if possible). -**Expected behavior:** - -What did you expect the App to do? - -**Observed behavior:** - -What did you see instead? Describe your issue in detail here. - **Device and Android version:** What make and model device (e.g., Samsung J7) did you encounter this on? What Android @@ -28,7 +20,7 @@ version (e.g., Android 4.0 Ice Cream Sandwich or Android 6.0 Marshmallow) are yo **Commons app version:** -You can find this information by going to the navigation drawer in the app and tapping 'About' +You can find this information by going to the navigation drawer in the app and tapping 'About'. If you are building from our codebase instead of downloading the app, please also mention the branch and build variant (e.g. master and prodDebug). **Screen-shots:** From 779704812c14713a455fa6ed5f88b81d4a9ff05d Mon Sep 17 00:00:00 2001 From: Josephine Lim Date: Fri, 29 Jun 2018 03:11:35 +1000 Subject: [PATCH 2/2] Add description to "steps to reproduce" --- ISSUE_TEMPLATE.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md index ce33f1a18..8feca4268 100644 --- a/ISSUE_TEMPLATE.md +++ b/ISSUE_TEMPLATE.md @@ -6,7 +6,8 @@ _Before creating an issue, please search the existing issues to see if a similar **Steps to reproduce:** -How can we reproduce the issue? +How can we reproduce the issue? +What did you expect the app to do, and what did you see instead? **Add System logs:**