From 690933c1c0cf595ab5a346172bd4c5ed3507949b Mon Sep 17 00:00:00 2001 From: Mark Han Date: Wed, 30 Oct 2019 16:22:09 -0400 Subject: [PATCH 1/3] Modify grammar and spelling in ISSUE_TEMPLATE --- ISSUE_TEMPLATE.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md index c38753dee..5223bb8cc 100644 --- a/ISSUE_TEMPLATE.md +++ b/ISSUE_TEMPLATE.md @@ -1,11 +1,11 @@ ## 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: +* Java client build version or git revision if you use some shapshot: * Appium server version or git revision if you use some shapshot: * Desktop OS/version used to run Appium if necessary: * Node.js version (unless using Appium.app|exe) or Appium CLI or Appium.app|exe: @@ -19,14 +19,14 @@ 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: with sample code it's easier to reproduce the bug and there will be a quicker turn around time to fix it. 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 From 21becbded6a81b5fec4d5c87326bce0b6185c5f6 Mon Sep 17 00:00:00 2001 From: Mark Han Date: Wed, 30 Oct 2019 16:26:13 -0400 Subject: [PATCH 2/3] Modify sample code sentence --- ISSUE_TEMPLATE.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md index 5223bb8cc..4f57b359e 100644 --- a/ISSUE_TEMPLATE.md +++ b/ISSUE_TEMPLATE.md @@ -19,7 +19,7 @@ Please provide more details, if necessary. ## Code To Reproduce Issue [ Good To Have ] -Please remember: with sample code it's easier to reproduce the bug and there will be a quicker turn around time 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/) From 13325477a677e142302dd82fdbbb3716885d448d Mon Sep 17 00:00:00 2001 From: Mark Han Date: Fri, 8 Nov 2019 13:22:27 -0500 Subject: [PATCH 3/3] correct Shapshot typo, and capitalization --- ISSUE_TEMPLATE.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md index 4f57b359e..6dc55c833 100644 --- a/ISSUE_TEMPLATE.md +++ b/ISSUE_TEMPLATE.md @@ -5,8 +5,8 @@ If there is a feature that you would like to see added to the Appium Java client ## 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: @@ -24,11 +24,11 @@ You can git clone https://github.com/appium/appium/tree/master/sample-code or ht 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/) -## Exception stacktraces +## Exception Stacktraces 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.