Wichtig

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.

Anleitung zum Berichten über Fehler

Dieser Leitfaden enthält Schritt-für-Schritt-Anweisungen zur Berichterstattung von Fehlern und Problemen, die Sie in Jami treffen.

Setzen Sie Ihre Umgebung ein

  • Bereiten Sie sich auf Datenverlust vor, sichern Sie Ihr Konto ein und verknüpfen Sie Ihr Konto mit so vielen Geräten wie möglich.

  • Die Berichterstattung von Fehlern/Fragen gegenüber älteren Versionen ist weniger nützlich und es besteht die Wahrscheinlichkeit, dass sie bereits in neueren Versionen behoben worden ist.

Wie man einen Bug melden kann

  1. Erstellen Sie ein Konto im [Jami GitLab]https://git.jami.net/users/sign_up) wenn Sie noch kein Konto haben.

  2. Wählen Sie das richtige Projekt aus, um Ihre Ausgabe in:

    • Der Android-Client ist ein

    • Das Projekt wird von einem Kunden ausgehend von einem anderen Kunden ausgehend von einem anderen Kunden ausgehend von einem anderen Kunden ausgehend von einem anderen Kunden ausgehend von einem anderen Kunden ausgehend von einem anderen Kunden ausgehend von einem anderen Kunden ausgehend von einem anderen Kunden ausgehend von einem anderen Kunden ausgehend von einem anderen Kunden ausgehend von einem anderen Kunden ausgehend von einem anderen Kunden ausgehend von einem anderen Kunden ausgehend von einem anderen Kunden ausgehend von einem anderen Kunden ausgehend von einem anderen Kunden ausgehend von einem anderen Kunden ausgehend von einem anderen Kunden ausgehend von einem anderen Kunden ausgehend von einem anderen Kunden ausgehend von einem anderen Kunden ausgehend von einem anderen Kunden ausgehend von einem anderen Kunden ausgehend von einem anderen Kunden ausgehend von einem anderen.

    • Das iOS-Client

    • Der macOS-Client (abgeschafft durch der Qt-Client)

    • Das Jami-Projekt im Allgemeinen (oder wenn Sie sich nicht sicher sind)

    • [Wenn Sie wissen, was Sie tun, können Sie sich für eines der anderen Projekte entscheiden]

  3. Wenn Sie mehrere Probleme haben, können Sie bitte separate Fehlerberichte einreichen. Auf diese Weise wird es viel einfacher sein, sie zu verfolgen.

  4. Der Titel ist eine explizite Zusammenfassung des Bugs (z.B.: Headerbar ist wegen der Symbolgröße zu groß)

  5. Ermitteln Sie die Schritte zur Wiedergabe des Bugs:

    • Wenn Sie genaue Schritte zur Wiedergabe haben (groß!) sind Sie auf dem Weg zu einem hilfreichen Bug-Bericht.

    • Wenn Sie gelegentlich wiederholen können, aber nicht nach bestimmten Schritten, geben Sie bitte zusätzliche Informationen über die Frage, um anderen zu helfen, sie zu verstehen und zu versuchen, sie zu reproduzieren.

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

  6. Stellen Sie sicher, dass Ihre Software aktuell ist.

  7. Versuchen Sie, sich von der Umwelt zu isolieren und zu reproduzieren (d. h. auf mehreren Geräten zu testen).

  8. Beschreiben Sie Ihre Umgebung (s) und geben Sie Folgendes an:

    • Betriebssystemversion

    • genaues Gerätemodell (wichtig für mobile Geräte)

    • wenn Sie eine Beta-Version verwenden

    • what build you are using (F-Droid, Play Store, App Store, from 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 elements if needed:

      • SIP provider,

      • hardware,

      • etc.

Eine klare Zusammenfassung zu schreiben

Wie würden Sie den Bug mit etwa 10 Wörtern beschreiben?

Eine gute Zusammenfassung sollte einen Fehlerbericht schnell und eindeutig identifizieren und das Problem erklären, nicht die vorgeschlagene Lösung.

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"

Schreibung präziser Reproduktionsschritte

  • Wie kann ein Entwickler den Bug auf seinem eigenen Gerät reproduzieren?

    Die Schritte zur Wiedergabe sind der wichtigste Teil eines Fehlerberichts. Wenn ein Entwickler den Fehler reproduzieren kann, wird der Fehler sehr wahrscheinlich behoben. Wenn die Schritte unklar sind, ist es vielleicht nicht einmal möglich zu wissen, ob der Fehler behoben wurde. Wir sind uns bewusst, dass einige Fehler für Sie offensichtlich aussehen können, aber sie sind wahrscheinlich mit Ihrer Umgebung in Verbindung gebracht. Je genauer Sie sind, desto schneller kann der Fehler behoben werden.

  • Was sollten Sie in einen Fehlerbericht aufnehmen?

    Zeigen Sie an, ob Sie den Fehler nach Belieben, gelegentlich oder gar nicht reproduzieren können. Beschreiben Sie Ihre Art und Weise, mit Jami zu interagieren, zusätzlich zu der Absicht jedes Schritts. Nach Ihren Schritten beschreiben Sie genau das beobachtete (tatsächliche) Ergebnis und das erwartete Ergebnis. Trennen Sie Fakten (Beobachtungen) von Spekulationen deutlich.

Good

Ich kann mich immer reproduzieren, indem ich diese Schritte befolge:

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

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.

Bad

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

Erlangtes Ergebnis

Bitte fügen Sie Folgendes ein:

  • Der Jami-Demon (jamid oder libjami oder Libring) und der Client-Debug-Logs.

  • Der Kern-Dump, wenn man ihn produziert hat.

Erwartetes Ergebnis

Es ist eine Beschreibung des erwarteten oder gewünschten Verhaltens.

Zusätzliche Informationen

Für die meisten Fehlermeldungen werden folgende Informationen angefordert. Sie können Zeit sparen, indem Sie diese Informationen unter den erwarteten Ergebnissen angeben.

Die Verzeichnisse

Qt-basierter Jami-Client (GNU/Linux, Windows, macOS)

Go to the General settings. In the Troubleshoot section, you can click on „Open logs“, where you will be able to get statistics („Show stats“) or start recording information via „Receive logs“. Then you can just copy the result and explain your scenario.

Auf GNU/Linux

Klassische Logs (Standardlogs >= Warnung sind nur registriert):

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

Vollprotokoll: Da der Jami-Client (GUI) und der Daemon getrennte Prozesse sind, ist der einfachste Weg, Logs von beiden zu erhalten, sie manuell eins nach dem anderen zu starten.

  1. Stellen Sie sicher, dass keine Jami-Client- oder Daemon-Instanzen laufen: Überprüfen Sie, indem Sie ps aux 〇 grep jami in einem Terminal laufen.

    • Jami kann noch laufen, auch wenn keine Fenster offen sind, je nach Ihren Vorlieben.

    • Wenn entweder Client oder Daemon läuft, beenden Sie sie mit kill PID.

  2. In einem Terminal starten Sie den Daemon mit jamid -d -c

    • Dieser Ausführbarkeit ist in der Regel nicht in der PATH, und in den Debian/Trisquel/Ubuntu Paketen befindet sich er unter /usr/lib/x86_64-linux-gnu/jamid -d -c oder /usr/libexec/jamid -d -c.

  3. In einem anderen Terminal starten Sie den Client mit jami -d.

Um zurückzuverfolgen, können Sie das Programm in GDB ausführen:

gdb -ex run --args jami -d, oder gdb -ex run --args /usr/libexec/jamid -cd, je nach Komponente, die Sie debuggen müssen.

Wenn es abstürzt, können Sie bt (oder noch besser, thread alle bt anwenden) eingeben, dann drücken Sie Enter. Dann kopieren Sie die Rückverfolgung und fügen Sie sie in die Ausgabe ein.

Auf macOS

  • Navigieren Sie zu /Applications/Jami.app/Contents/MacOS/.

  • Doppelklick Jami, es startet Jami und druckt das Protokoll zum Terminal.

  • Kopieren Sie das Protokoll von Terminal in eine Datei.

Alternativ können Sie /<Path zu Jami>/Jami.app/Contents/MacOS/Jami -d vom Terminal aus laufen.

Auf Android

Um Logs über Ihr Telefon zu sammeln, indem Sie Jami selbst benutzen:

  • Tipp Gespräche

  • Tippen Sie auf das Dreistrichmenü oben rechts

  • Tipp Einstellungen

  • Tipp Diagnostiklogs

Um Logs über Ihren Computer mit der Android Debug Bridge (adb) zu sammeln:

  • Sie müssen AdB auf Ihrem Computer einrichten.

  • Start Jami auf deinem Smartphone und dann ausführen

  • Ich habe die Möglichkeit, mich zu verhalten, aber ich bin nicht sicher, dass ich das tun kann.

  • Sie haben jetzt eine Datei mit dem Protokoll des Kunden

Für Windows

Öffnen Sie ein Terminal (cmd.exe) und starten Sie Jami.exe mit folgenden Optionen:

  • -d eine separate Konsolefenster zu öffnen, um Logs zu empfangen

  • -f zu schreiben Logs zu %localappdata%\jami\jami.log