Skip to content

Commit 4f19710

Browse files
Mark Hansaikrishna321
Mark Han
authored andcommitted
Improve Readability of Issue Template (#1260)
* Modify grammar and spelling in ISSUE_TEMPLATE * Modify sample code sentence * correct Shapshot typo, and capitalization
1 parent c98ff29 commit 4f19710

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

ISSUE_TEMPLATE.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
## Description
22

3-
Please describe the issue. It may be a bug description. So then please briefly descride steps which you were trying to perform and what happened instead.
4-
If there is the feature you want to see added to Appium Java client so please describe necessity of this feature and the way that it should work.
3+
Please describe the issue. If it is a bug, please briefly describe the steps to reproduce and the actual vs expected behavior.
4+
If there is a feature that you would like to see added to the Appium Java client, please describe the necessity of this feature and the way that it should work.
55

66
## Environment
77

8-
* java client build version or git revision if you use some shapshot:
9-
* Appium server version or git revision if you use some shapshot:
8+
* Java client build version or git revision if you use some snapshot:
9+
* Appium server version or git revision if you use some snapshot:
1010
* Desktop OS/version used to run Appium if necessary:
1111
* Node.js version (unless using Appium.app|exe) or Appium CLI or Appium.app|exe:
1212
* Mobile platform/version under test:
@@ -19,16 +19,16 @@ Please provide more details, if necessary.
1919

2020
## Code To Reproduce Issue [ Good To Have ]
2121

22-
Please remember that, with sample code; it's easier to reproduce bug and much faster to fix it.
22+
Please remember: it's easier to reproduce and fix the bug with sample code.
2323
You can git clone https://github.com/appium/appium/tree/master/sample-code or https://github.com/appium/appium/tree/master/sample-code/apps and reproduce an issue using Java and sample apps.
2424
Also you can create a [gist](https://gist.github.com) with pasted java code sample or put it here using markdown. About markdown please read [Mastering markdown](https://guides.github.com/features/mastering-markdown/) and
2525
[Writing on GitHub](https://help.github.com/categories/writing-on-github/)
2626

27-
## Ecxeption stacktraces
27+
## Exception Stacktraces
2828

29-
Please create a [gist](https://gist.github.com) with pasted stacktrace of exception thrown by java.
29+
Please create a [gist](https://gist.github.com) with the pasted stacktrace of the exception thrown by java.
3030

31-
## Link to Appium logs
31+
## Link To Appium Logs
3232

3333
Please create a [gist](https://gist.github.com) which is a paste of your _full_ Appium logs, and link them here. Do _not_ paste your full Appium logs here, as it will make this issue very long and hard to read!
3434
If you are reporting a bug, _always_ include Appium logs as linked gists! It helps to define the problem correctly and clearly.

0 commit comments

Comments
 (0)