Skip to content

Commit c96a4af

Browse files
domdomeggneslihanturan
authored andcommitted
Update issue and PR templates (commons-app#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
1 parent 784999b commit c96a4af

File tree

2 files changed

+19
-17
lines changed

2 files changed

+19
-17
lines changed

ISSUE_TEMPLATE.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,24 +2,28 @@
22

33
Summarize your issue in one sentence (what goes wrong, what did you expect to happen)
44

5-
_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._
5+
_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._
66

77
**Steps to reproduce:**
88

99
How can we reproduce the issue?
1010
What did you expect the app to do, and what did you see instead?
1111

12-
**Add System logs:**
12+
**System logs:**
1313

14+
```
1415
Add logcat files here (if possible).
1516
17+
Need help? See https://github.com/commons-app/apps-android-commons/wiki/Getting-app-logs-from-Android-Studio
18+
```
19+
1620
**Device and Android version:**
1721

18-
What make and model device (e.g., Samsung J7) did you encounter this on? What Android
19-
version (e.g., Android 4.0 Ice Cream Sandwich or Android 6.0 Marshmallow) are you running? Is it
20-
the stock version from the manufacturer or a custom ROM ?
22+
What make and model device (e.g., Samsung J7) did you encounter this on?
23+
What Android version (e.g., Android 4.0 Ice Cream Sandwich or Android 6.0 Marshmallow) are you running?
24+
Is it the stock version from the manufacturer or a custom ROM ?
2125

22-
**Commons app version:**
26+
**Commons app version:**
2327

2428
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).
2529

PULL_REQUEST_TEMPLATE.md

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,17 @@
1-
## Title (required)
1+
**Description (required)**
22

3-
Fixes #{GitHub issue number and title (Please do not forget adding title) }
3+
Fixes #{GitHub issue number} {Github issue title}
44

5-
## Description (required)
5+
What changes did you make and why?
66

7-
Fixes #{GitHub issue number and title}
7+
**Tests performed (required)**
88

9-
{Describe the changes made and why they were made.}
9+
Tested {build variant, e.g. ProdDebug} on {name of device or emulator} with API level {API level}.
1010

11-
## Tests performed (required)
11+
**Screenshots showing what changed (optional - for UI changes)**
1212

13-
Tested on {API level & name of device/emulator}, with {build variant, e.g. ProdDebug}.
13+
Need help? See https://support.google.com/android/answer/9075928
1414

15-
## Screenshots showing what changed (optional)
16-
17-
{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)}
15+
---
1816

19-
_Note: Please ensure that you have read CONTRIBUTING.md if this is your first pull request._
17+
_Note: Please ensure that you have read CONTRIBUTING.md if this is your first pull request._

0 commit comments

Comments
 (0)