חשוב

We are currently a small number of developers active on the project. As such, we cannot answer and tag all of the opened issues immediately, but we do notice and read them. Good bug reports provide us important feedback, which we thank you for and always appreciate.

מדריך דו“ח חרקים

מדריך זה כולל הוראות צעד אחר צעד על מנת לדווח על טעויות ותשאלות שתפגשו בג’מי.

תארגן את הסביבה שלך

  • היכונו לאיבוד נתונים. תפקד תיעוד אח“כ של החשבון שלך ותחבר את החשבון שלך לכל האמצעים האפשריים.

  • להתקין את הגרסה האחרונה (או אפילו גרסה בטה) של ג’מי. דיווח על טעויות/בעיות עם גרסאות ישנות הוא פחות שימושי, ויש סיכוי שזה כבר תיקון גרסאות חדשות.

איך לדווח על תבוך

  1. Only required once: Create a Jami GitLab account.

  2. בחר את הפרויקט הנכון לפרסם את הנושא שלך:

  3. אם יש לך בעיות רבות, בבקשה תגיש דוחות טעויות נפרדות. יהיה הרבה יותר קל לעקוב אחריהם בדרך זו.

  4. The title is an explicit summary of the bug (for example, the header bar is too big due to icon size).

  5. תחשבו על הצעדים כדי להפיק את החייד:

    • If you have precise steps to reproduce it (great!), you’re on your way to creating a helpful bug report.

    • If you can reproduce it occasionally but not after following specific steps, please provide additional information about the issue to help others understand and try to reproduce it.

    • If you can not reproduce the problem, there may be little chance of it being reasonably fixable. If you do report it, please provide as much information/clues about its occurrence as possible.

  6. Ensure your software is up to date. Ideally, test an in-development version to see whether your bug has already been fixed.

  7. Attempt to isolate from the environment and reproduce (that is, test on multiple devices).

  8. תיאר את הסביבה שלך (s) על ידי תיאור הדברים הבאים:

    • Operating system and version

    • Precise device model (important for mobile devices)

    • Stable or beta version of Jami

    • What build you are using (F-Droid, Google Play, App Store, dl.jami.net, your own build, etc.). If you have built your own version of Jami, please specify the exact Jami Daemon version and client version (you can obtain it using jamid -v and jami -v; but note that our packages are updated quite often) and the Git commit.

    • Network conditions:

      • Are both devices on the same local network?

      • Different networks?

      • Is one or both behind NAT?

      • Are you using LTE?

      • Are you using WiFi?

    • Other details if required:

      • SIP provider,

      • Hardware,

      • etc.

כתיבת סיכום ברור

איך היית מתאר את הטעות באמצעות כ-10 מילים? זהו החלק הראשון של דו“ח הטעות שלך יראה מפעיל.

סיכום טוב צריך לזהות במהירות וביחידה דו“ח שגיאה. זה צריך להסביר את הבעיה, לא הפתרון המוצע שלך.

Good: "Cancelling a file transfer crashes Jami"
Bad: "Software crashes"

Good: "All calls hang up after 32 seconds"
Bad: "Not able to call my friends"

כתיבת צעדים מדויקים כדי להשיב

  • איך מתכנן יכול להפיק את החולצה במכשיר שלו?

    Steps to reproduce are the most important part of any bug report. If a developer is able to reproduce the bug, the bug is very likely to be fixed. If the steps are unclear, it might not even be possible to know whether the bug has been fixed. We are totally aware that some bugs may look obvious to you, but they are probably related to your environment. The more precise you are, the quicker the bug can be fixed.

  • מה כדאי שתכלל בדוח על תדויות?

    Indicate whether you can reproduce the bug at will, occasionally, or not at all. Describe your method of interacting with Jami in addition to the intent of each step. After your steps, precisely describe the observed (actual) result and the expected result. Clearly separate facts (observations) from speculations.

Good

אני תמיד יכול להתרבות בעקבות הצעדים האלה:

1. Start Jami by clicking on the desktop icon.
2. Start a new conversation with anyone.
3. Click the file transfer button.

Expected results: A window opens and asks me to choose a file to send.
Actual results: When I click the file transfer button, nothing happens.

Bad

Attempt to transfer a file.
It doesn't work.

Obtained result

אנא הוסף:

  • הדיימון של ג’מי (ג’מיד או ליבג’י או לירות) ושישורי תיקון לקלינט.

  • The core dump, if one was produced.

Expected result

A description of the expected or desired behavior.

מסירת מידע נוסף

The following information is requested for most bug reports. You can save time by providing this information below the expected results.

חתיכות

אנדרואיד

To gather logs via the Android device using Jami:

  1. Tap Conversations.

  2. Tap the ⋮ (three-dot) menu on the top right.

  3. Tap Settings.

  4. Tap Diagnostic logs.

To gather logs via a computer using the Android Debug Bridge (adb):

  1. The adb is required to be set up on your computer.

  2. Launch Jami on your smartphone and then execute adb logcat *:D | grep `adb shell ps | egrep 'cx.ring' | cut -c10-15` > logring.txt

  3. יש לך עכשיו קבוצה המכילה את היומן של הלקוח

Desktop Jami client based on the Qt framework (GNU/Linux, macOS, Windows)

  1. Open the General tab in the settings.

  2. In the Troubleshoot section, click the Open logs button.

  3. Turn on the View logs switch.

  4. Click the Copy button.

  5. Paste the result and explain the scenario in the issue.

GNU/Linux

שיטות קלאסיות (בדרך כלל שיטות אזהרה >= בלבד נדווגות):

journalctl --since "24h ago" | grep jami

Full log: The Jami client (GUI) and daemon are separate processes. To obtain logs from both processes, start each process manually, one at a time.

  1. לוודא שאין לקוח ג’מי או דיימון מדוגמת פועלות: לבדוק על ידי לנהל `ps aux ‬

    • ג’מי אולי עדיין פועלת גם אם חלונות לא פתוחים, בהתאם לעדפותיך.

    • אם כל אחד מהלקוחות או הדיימון פועלים, לסיים אותם באמצעות kill PID.

  2. באחד הטרמינלים, להתחיל את הדיימון עם jamid -d -c

    • זה ניתן לבצע בדרך כלל לא ב- PATH, ובחבילות Debian/Trisquel/Ubuntu, הוא ממוקם ב- /usr/lib/x86_64-linux-gnu/jamid -d -c או /usr/libexec/jamid -d -c.

  3. In another terminal, start the client, using jami -d.

כדי לקבל עקבות אחורה, אתה יכול להפעיל את התוכנית בתוך GDB:

gdb -ex run --args jami -d, or gdb -ex run --args /usr/libexec/jamid -cd, depending on the component you need to debug.

כאשר זה מתנגש, אתה יכול להקליד bt (או אפילו יותר טוב, thread ליישם את כל bt) ואז לחץ על Enter.

macOS

  1. לכו ל- /Applications/Jami.app/Contents/MacOS/.

  2. לחץ פעמיים על ג’מי, זה יפעיל את ג’מי וידפיס את היומן לתרמיל.

  3. עותק את היומן מהטרמונל לקובץ.

באופן חלופי, אתה יכול לנהל /<דרך לג'מי>/ג'מי.אפ/תוכן/מקרוס/ג'מי -ד מהטרמונל.

חלונות

  1. Open the command prompt (cmd.exe)

  2. Run Jami.exe with the following options:

    • -d לפתוח חלון קונסול נפרד לקבלת רשומות

    • -f לכתוב רישומים ל % lokappdata%\jami\jami.log