Fontos

Jelenleg kevés fejlesztő aktív a projekten. Emiatt nem lehet azonnal válaszokat és címkéket adni az összes nyitott problémára, de a csapat észreveszi és elolvassa azokat. A jó hibajelentések fontos visszajelzést adnak, amit a csapat köszön és mindig nagyra értékel.

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. Csak egyszer szükséges: Jami GitLab-fiók létrehozása.

  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. Az angol nyelvű cím a hiba explicit összefoglalása (például: the header bar is too big due to icon size).

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

    • Ha vannak pontos lépéseid a reprodukálásához (nagyszerű!), akkor jó úton haladsz egy hasznos hibajelentés létrehozása felé.

    • Ha időnként sikerül ismételni a hibát, de bizonyos lépések követése után nem, kérjük, adjon meg további információkat a problémáról, hogy mások is megérthessék és megpróbálhassák megismételni.

    • Ha nem tudja ismételni a hibát, akkor kicsi az esélye annak, hogy ésszerűen javítható. Ha mégis bejelenti, kérjük, próbáljon meg minél több adatot/nyomokat közölni az előfordulásáról.

  6. Győződjön meg róla, hogy a szoftver naprakész. Ideális esetben teszteljen egy fejlesztés alatt álló verziót, hogy megtudja, javították-e már a hibát.

  7. Próbálja meg elszigetelni a környezettől, és reprodukálni (azaz több eszközön tesztelni).

  8. Jellemezze környezeteit a következők megadásával:

    • Operációs rendszer és változat

    • Pontos eszközmodell (fontos mobileszközök esetén)

    • A Jami stabil vagy béta változata

    • Milyen építési csomagokat használsz (F-Droid, Google Play, App Store, dl.jami.net, saját építés stb.)? Ha a Jami saját verzióját építetted, kérjük, add meg a Jami-rendszerfolyamat és az ügyfél pontos verzióját (ezt a jamid -v és jami -v paranccsal szerezheted be; de ​​vedd figyelembe, hogy a csomagjaink elég gyakran frissülnek), valamint a Git-véglegesítést.

    • Hálózati feltételek:

      • Mindkét eszköz ugyanazon a helyi hálózaton van?

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

    • További részletek, ha szükséges:

      • SIP-szolgáltató,

      • Hardver,

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

    Az ismétlődő lépések minden hibajelentés legfontosabb részét képezik. Ha egy fejlesztő képes megismételni a hibát, nagy valószínűséggel kijavítják a hibát. Ha a lépések nem egyértelműek, előfordulhat, hogy nem is lehet tudni, hogy a hibát javították-e. Tisztában vagyunk vele, hogy bizonyos hibák nyilvánvalónak tűnhetnek az Ön számára, de valószínűleg a környezetével kapcsolatosak. Minél pontosabb, annál gyorsabban javítható a hiba.

  • Mit kell szerepeltetni a hibajelentésben?

    Jelezze, hogy megismételheti-e a hibát tetszés szerint, alkalmanként vagy egyáltalán nem. Az egyes lépések szándéka mellett írja le a Jamival való interakciós módszert. Lépései után pontosan írja le a megfigyelt (tényleges) és a várt eredményt. Világosan válassza el a tényeket (megfigyeléseket) a találgatásoktól.

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.

Megszerzett eredmény

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

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

  • A maglerakás, ha előállították.

Várható eredmény

A várt vagy kívánt viselkedés leírása.

További adatok megadása

A legtöbb hibajelentéshez a következő információkat kérjük. Időt takaríthat meg, ha ezeket az információkat a várható eredmények alatt adja meg.

Naplók

Android

Naplók gyűjtése Android-eszközön keresztül a Jami használatával:

  1. Koppintson a Beszélgetések elemre.

  2. Koppintson a ⋮ (hárompontos) menüre a jobb felső sarokban.

  3. Koppintson a Beállítások elemre.

  4. Koppintson a Diagnosztikai naplók elemre.

A naplók összegyűjtése a számítógépen keresztül az adb (Android Debug Bridge – Android-hibakeresőhíd) használatával:

  1. Az adb eszközt be kell állítani a számítógépen.

  2. Indítsd el a Jami-t az okostelefonodon, majd futtasd az adb logcat *:D | grep `adb shell ps | egrep 'cx.ring' | cut -c10-15` > logring.txt parancsot.

  3. Most van egy fájl, amely az ügyfél naplóját tartalmazza

Qt-keretrendszeren alapuló asztali Jami-ügyfél (GNU/Linux, macOS, Windows)

  1. Nyisd meg az Általános fület a beállításokban.

  2. A Hibaelhárítás részben kattintson a Naplók megnyitása gombra.

  3. Kapcsold be a Naplók megtekintése kapcsolót.

  4. Kattintson a Másolás gombra.

  5. Illeszd be az eredményt, és magyarázd el a forgatókönyvet a feladatban.

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.

Vagy a /<path to Jami>/Jami.app/Contents/MacOS/Jami -d parancs futtatása a terminálról.

Az ablakok

  1. Nyisd meg a parancssort (cmd.exe)

  2. Futtassa a Jami.exe-fájlt a következő beállításokkal:

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