diff --git a/guides/how-to-report-bugs.md b/guides/how-to-report-bugs.md index fcfeeb3405b86a0f268d5c4d1290c720d74add07..6ea63e90a60f058aa4a12a4c9d4489e4f1afd3b3 100644 --- a/guides/how-to-report-bugs.md +++ b/guides/how-to-report-bugs.md @@ -35,7 +35,8 @@ if you don't have one already. 2\. If you have multiple issues, please file separate bug reports. It will be much easier to keep track of them that way. -3\. Title is an explicit summary of the bug (e.g.: header bar is too big due to icon size) +3\. The title is an explicit summary of the bug (e.g.: header bar is +too big due to icon size) 4\. Figure out the steps to reproduce the bug: @@ -52,7 +53,7 @@ It will be much easier to keep track of them that way. 5\. Make sure your software is up to date. Ideally, test an in-development version to see whether your bug has already been fixed. -6\. Try to isolate from environment and reproduce (i.e. test on +6\. Try to isolate from the environment and reproduce (i.e. test on multiple devices). 7\. Describe your environment(s) by specifying the following: @@ -120,7 +121,7 @@ I can always reproduce by following these steps: 2. Start a new conversation with anyone 3. Click the file transfer icon -Expected results: A window opens and ask me to choose a file to send. +Expected results: A window opens and asks me to choose a file to send. Actual results: When I click the file transfer icon, nothing happens. ``` @@ -136,7 +137,7 @@ Obtained Result Please include: -+ The daemon and client debug logs. ++ The Jami daemon (jamid or libjami or libring) and client debug logs. + The core dump if one was produced. Expected Result @@ -215,7 +216,7 @@ To gather logs via your phone using Jami itself: To gather logs via your computer using the Android Debug Bridge (adb): -+ You need to have adb setup on your computer. ++ You need to have adb set up on your computer. + Launch Jami on your smartphone and then execute + ```adb logcat *:D | grep `adb shell ps | egrep 'cx.ring' | cut -c10-15` > logring.txt``` + You now have a file containing the log of the client @@ -227,4 +228,3 @@ options: + `-d` to open a separate console window to receive logs + `-f` to write logs to `%localappdata%\jami\jami.log` -+ `-c` to print logs directly to the Visual Studio debug output window