From c96a4aff4013fc9babd98363f8ebe92a624e6dc7 Mon Sep 17 00:00:00 2001 From: Adam Jones Date: Mon, 5 Nov 2018 09:31:15 +0000 Subject: [PATCH] Update issue and PR templates (#1972) * Update ISSUE_TEMPLATE.md with wiki link and minor formatting changes * Update PULL_REQUEST_TEMPLATE.md making the formatting more similar to the issue template, simplifying some language and improving links --- ISSUE_TEMPLATE.md | 16 ++++++++++------ PULL_REQUEST_TEMPLATE.md | 20 +++++++++----------- 2 files changed, 19 insertions(+), 17 deletions(-) diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md index 8feca4268..12ff064e2 100644 --- a/ISSUE_TEMPLATE.md +++ b/ISSUE_TEMPLATE.md @@ -2,24 +2,28 @@ 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._ +_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? What did you expect the app to do, and what did you see instead? -**Add System logs:** +**System logs:** +``` Add logcat files here (if possible). +Need help? See https://github.com/commons-app/apps-android-commons/wiki/Getting-app-logs-from-Android-Studio +``` + **Device and Android version:** -What make and model device (e.g., Samsung J7) did you encounter this on? What Android -version (e.g., Android 4.0 Ice Cream Sandwich or Android 6.0 Marshmallow) are you running? Is it - the stock version from the manufacturer or a custom ROM ? +What make and model device (e.g., Samsung J7) did you encounter this on? +What Android version (e.g., Android 4.0 Ice Cream Sandwich or Android 6.0 Marshmallow) are you running? +Is it the stock version from the manufacturer or a custom ROM ? - **Commons app version:** +**Commons app version:** 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). diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md index 37e104d14..50634fa60 100644 --- a/PULL_REQUEST_TEMPLATE.md +++ b/PULL_REQUEST_TEMPLATE.md @@ -1,19 +1,17 @@ -## Title (required) +**Description (required)** -Fixes #{GitHub issue number and title (Please do not forget adding title) } +Fixes #{GitHub issue number} {Github issue title} -## Description (required) +What changes did you make and why? -Fixes #{GitHub issue number and title} +**Tests performed (required)** -{Describe the changes made and why they were made.} +Tested {build variant, e.g. ProdDebug} on {name of device or emulator} with API level {API level}. -## Tests performed (required) +**Screenshots showing what changed (optional - for UI changes)** -Tested on {API level & name of device/emulator}, with {build variant, e.g. ProdDebug}. +Need help? See https://support.google.com/android/answer/9075928 -## Screenshots showing what changed (optional) - -{Only for user interface changes, otherwise remove this section. See [how to take a screenshot](https://android.stackexchange.com/questions/1759/how-to-take-a-screenshot-with-an-android-device)} +--- -_Note: Please ensure that you have read CONTRIBUTING.md if this is your first pull request._ \ No newline at end of file +_Note: Please ensure that you have read CONTRIBUTING.md if this is your first pull request._