Skip to content

Commit

Permalink
Improve Readability of Issue Template (#1260)
Browse files Browse the repository at this point in the history
* Modify grammar and spelling in ISSUE_TEMPLATE

* Modify sample code sentence

* correct Shapshot typo, and capitalization
  • Loading branch information
Mark Han authored and saikrishna321 committed Nov 11, 2019
1 parent c98ff29 commit 4f19710
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
## Description

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.
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.
Please describe the issue. If it is a bug, please briefly describe the steps to reproduce and the actual vs expected behavior.
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.

## Environment

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

## Code To Reproduce Issue [ Good To Have ]

Please remember that, with sample code; it's easier to reproduce bug and much faster to fix it.
Please remember: it's easier to reproduce and fix the bug with sample code.
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.
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
[Writing on GitHub](https://help.github.com/categories/writing-on-github/)

## Ecxeption stacktraces
## Exception Stacktraces

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

## Link to Appium logs
## Link To Appium Logs

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!
If you are reporting a bug, _always_ include Appium logs as linked gists! It helps to define the problem correctly and clearly.

0 comments on commit 4f19710

Please sign in to comment.