mnalis/apps-android-commons
1
0
Fork 0
mirror of https://github.com/commons-app/apps-android-commons.git synced 2025-10-26 20:33:53 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Update issue and PR templates (#1972)

Browse source 
* 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
This commit is contained in:
Adam Jones 2018-11-05 09:31:15 +00:00 • committed by neslihanturan
parent 784999bb49
commit c96a4aff40
2 changed files with 19 additions and 17 deletions
Download patch file Download diff file Expand all files Collapse all files

16
ISSUE_TEMPLATE.md
View file

@ -2,24 +2,28 @@
Summarize your issue in one sentence (what goes wrong, what did you expect to happen) 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:** **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? 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). 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:** **Device and Android version:**
What make and model device (e.g., Samsung J7) did you encounter this on? What Android What make and model device (e.g., Samsung J7) did you encounter this on?
version (e.g., Android 4.0 Ice Cream Sandwich or Android 6.0 Marshmallow) are you running? Is it What Android version (e.g., Android 4.0 Ice Cream Sandwich or Android 6.0 Marshmallow) are you running?
the stock version from the manufacturer or a custom ROM ? 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). 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).

18
PULL_REQUEST_TEMPLATE.md
View file

@ -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._ _Note: Please ensure that you have read CONTRIBUTING.md if this is your first pull request._