Fontos

Jelenleg kevés fejlesztő vesz részt a projektben. Ezért nem tudunk azonnal válaszolni és megjelölni az összes megnyitott kérdést, de észrevesszük és elolvassuk őket. A jó hibajelentések fontos visszajelzést adnak nekünk, amit köszönünk, és mindig nagyra értékelünk.

Hibabejelentési útmutató

Ez az útmutató lépésről lépésre tartalmaz utasításokat a Jami-ben tapasztalt hibák és problémák bejelentéséhez.

Környezet beállítása

  • Készüljön fel az adatvesztésre. Készítsen biztonsági másolatot fiókjáról, és kapcsolja össze fiókját a lehető legtöbb eszközzel.

  • Telepítse a Jami legújabb verzióját (vagy akár egy béta verzióját). A régebbi verziókkal kapcsolatos hibák/problémák jelentése kevésbé hasznos, és fennáll annak a valószínűsége, hogy az újabb verziókban már kijavították.

Hogyan jelentsünk hibát

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

  2. Válassza ki a megfelelő projektet a probléma közzétételéhez:

  3. Ha több problémája van, kérjük, küldjön külön hibajelentést. Sokkal könnyebb lesz így nyomon követni őket.

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

  5. Fontolja meg a hiba megismétlésének lépéseit:

    • 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. Jellemezze környezeteit a következők megadásával:

    • 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?

      • Különböző hálózatok?

      • Az egyik vagy mindkettő NAT mögött van?

      • LTE vezeték nélküli szélessávú kommunikációt használ?

      • Wi-Fi vezeték nélküli hálózatot használ?

    • Other details if required:

      • SIP-szolgáltató,

      • Hardware,

      • stb.

Egyértelmű összefoglaló írása

Hogyan jellemeznéd a hibát körülbelül 10 szóval? Ez a hibajelentés első része, amelyet a fejlesztő láthat.

Egy jó összefoglalónak gyorsan és egyértelműen azonosítania kell a hibajelentést. A problémát kell magyaráznia, nem a javasolt megoldást.

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"

Pontos lépések megismétlése

  • Hogyan tudja egy fejlesztő megismételni a hibát a saját eszközén?

    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.

  • Mit kell szerepeltetni a hibajelentésben?

    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.

Jó

Mindig meg tudom ismételni az alábbi lépéseket követve:

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.

Hibás

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

Obtained result

Kérjük, a következőket tartalmazza:

  • A Jami-rendszerfolyamat (jamid vagy libjami vagy libring) és az ügyfél hibakeresési naplói.

  • The core dump, if one was produced.

Expected result

A description of the expected or desired behavior.

További adatok megadása

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

Naplók

Android

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. Most van egy fájl, amely az ügyfél naplóját tartalmazza

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

Klasszikus naplók (alapértelmezés szerint csak a naplók >= figyelmeztetések kerülnek naplózásra):

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

Teljes napló: A Jami-ügyfél (grafikus felhasználói felület) és a rendszerfolyamat különálló folyamatok. Ha mindkét folyamatból szeretne naplót kapni, indítsa el az egyes folyamatokat kézzel, egyesével.

  1. Győződjön meg arról, hogy nem fut Jami-ügyfél vagy Jami-rendszerfolyamat példány: ellenőrizze a ps aux | grep jami terminálban.

    • A beállításoktól függően előfordulhat, hogy a Jami akkor is fut, ha egyetlen ablak sem van nyitva.

    • Ha akár ügyfél, akár rendszerfolyamat fut, zárja le őket a kill PID használatával.

  2. Az egyik terminálban indítsa el a rendszerfolyamatot a jamid -d -c paranccsal

    • Ez a végrehajtható fájl általában nem található a PATH-ban, a Debian/Trisquel/Ubuntu csomagokban pedig a /usr/lib/x86_64-linux-gnu/jamid -d -c vagy a /usr/libexec/jamid -d -c helyen található.

  3. Egy másik terminálban indítsa el az ügyfelet a jami -d használatával.

A visszakövetéshez futtassa a programot a GDB (GNU Project Debugger - GNU projekt hibakereső) eszközben:

gdb -ex run --args jami -d vagy gdb -ex run --args /usr/libexec/jamid -cd, attól függően, hogy melyik összetevőt kell hibakeresni.

Amikor összeomlik, beírhatja a bt szót (vagy még jobb, a thread apply all bt-t`), majd nyomja meg az Enter-billentyűt. Ezután másolja ki a visszakövetést, és illessze be a hibaszámba.

macOS

  1. Keresse meg az /Applications/Jami.app/Contents/MacOS/ mappát.

  2. Kattintson duplán a Jami alkalmazásra. Elindítja a Jami alkalmazást, és kinyomtatja a naplót a terminálra.

  3. Másolja a naplót a terminálról egy fájlba.

Egy másik lehetőség a /<path to Jami>/Jami.app/Contents/MacOS/Jami -d parancs futtatása a terminálról.

Az ablakok

  1. Open the command prompt (cmd.exe)

  2. Run Jami.exe with the following options:

    • -d egy külön kezelőpult ablak megnyitásához a naplók fogadásához

    • -f naplók írásához a %localappdata%\jami\jami.log fájlba