|
1 | | -... under construction |
| 1 | +#Be sure that it is not a server-side problem if you are facing something that looks like a bug |
| 2 | + |
| 3 | +The Appium Java client is the thin client which just sends requests and receives responces generally. |
| 4 | +Be sure that this bug is not reported [here](https://github.com/appium/appium/issues) and/or there is |
| 5 | +no progress on this issue. |
| 6 | + |
| 7 | +#The good issue report should contain |
| 8 | + |
| 9 | +## Description |
| 10 | + |
| 11 | +The bug report should contain a brief description of a bug. |
| 12 | +If it is the feature request then there should be the description of this feature and the way that it should work. |
| 13 | + |
| 14 | +## Environment (bug report) |
| 15 | + |
| 16 | +* java client build version or git revision if you use some shapshot: |
| 17 | +* Appium server version or git revision if you use some shapshot: |
| 18 | +* Desktop OS/version used to run Appium if necessary: |
| 19 | +* Node.js version (unless using Appium.app|exe) or Appium CLI or Appium.app|exe: |
| 20 | +* Mobile platform/version under test: |
| 21 | +* Real device or emulator/simulator: |
| 22 | + |
| 23 | +## Details |
| 24 | + |
| 25 | +If it is necessary there should provided more details |
| 26 | + |
| 27 | + |
| 28 | +## Code To Reproduce Issue [ Good To Have ] (bug report) |
| 29 | + |
| 30 | +It's easier to reproduce bug and much faster to fix it. |
| 31 | +You can git clone https://github.com/appium/sample-code or https://github.com/appium/sample-code/tree/master/sample-code/apps and reproduce an issue using Java and sample apps. |
| 32 | +Also you can create a [gist](https://gist.github.com) with pasted java code sample or paste it at ussue description using markdown. About markdown please read [Mastering markdown](https://guides.github.com/features/mastering-markdown/) and |
| 33 | +[Writing on GitHub](https://help.github.com/categories/writing-on-github/) |
| 34 | + |
| 35 | +## Ecxeption stacktraces (bug report) |
| 36 | + |
| 37 | +There should be created a [gist](https://gist.github.com) with pasted stacktrace of exception thrown by java. |
| 38 | + |
| 39 | +## Link to Appium logs |
| 40 | + |
| 41 | +There should be created 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 at the issue description, as it will make this issue very long and hard to read! |
| 42 | +If you are reporting a bug, _always_ include Appium logs as linked gists! It helps to define the problem correctly and clearly. |
| 43 | + |
| 44 | + |
| 45 | +#Issue template |
| 46 | +There is [ISSUE_TEMPLATE.md](https://github.com/appium/java-client/blob/master/ISSUE_TEMPLATE.md) which should help you to make a good issue report. |
| 47 | + |
| 48 | +#... And don't say that you weren't warned. |
| 49 | + |
| 50 | +If a report is not readable and/or there is no response from a reporter and some important details are needed then the issue will be closed after some time. |
0 commit comments