Ważne

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.

Przewodnik zgłaszania błędów

W tym przewodniku znajdują się instrukcje krok po kroku w celu zgłoszenia błędów i problemów, z którymi napotkasz w Jami.

Ustaw swoje środowisko

  • Przygotuj się na utratę danych, zapisz konto i połącz go z jak największą liczbą urządzeń.

  • W przypadku, gdy wprowadzono w systemie systemy, w przypadku, w których istnieje możliwość naprawy, należy zainstalować najnowszą wersję (lub nawet wersję beta) systemu Jami.

Jak zgłosić błąd

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

  2. Wybierz odpowiedni projekt, aby wysłać swój numer w:

  3. Jeśli masz wiele problemów, proszę złożyć oddzielne raporty o błędach.

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

  5. Zastanów się nad krokami w celu odtworzenia błędu:

    • 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. Opisz swoje środowisko (s) podając następujące informacje:

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

      • Inne sieci?

      • Jedno lub oba za NAT’em?

      • Używasz LTE?

      • Używasz WiFi?

    • Other details if required:

      • Dostawca SIP,

      • Hardware,

      • itp.

Napisanie jasnego podsumowania

Jak opisałbyś błąd przy użyciu około 10 słów?

Dobry podsumowanie powinno szybko i w sposób wyjątkowy zidentyfikować raport błędów.

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"

Napisanie precyzyjnych kroków do odtworzenia

  • Jak programista może odtworzyć błąd na swoim urządzeniu?

    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.

  • Co należy włączyć do raportu o błonach?

    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.

Dobre

Zawsze mogę się rozmnażać, podążając za tymi krokami:

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.

Złe

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

Obtained result

Proszę włączyć:

  • Demon Jami (jamid lub libjami lub libring) i logy defagowania klienta.

  • The core dump, if one was produced.

Expected result

A description of the expected or desired behavior.

Dostarczanie dodatkowych informacji

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

Płoty

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. Masz teraz plik zawierający zapisy klienta

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

Klasyczne zapisy (w domyślnym przypadku zapisywane są tylko zapisy >= ostrzeżenia):

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. Upewnij się, że nie działa żadnego klienta Jami lub instyncji demona: sprawdź, uruchamiając `ps aux ̶ ̶ ̶ grop jami ̶ w terminalu.

    • Jami może nadal działać, nawet jeśli nie ma otwartych okna, w zależności od twoich preferencji.

    • Jeśli klient lub demon działa, zakończ je używając kill PID.

  2. W jednym terminalu, rozpocząć demona z jamid -d -c

    • Ten wykonywalny zwykle nie znajduje się w PATH, a w pakietach Debian/Trisquel/Ubuntu znajduje się w /usr/lib/x86_64-linux-gnu/jamid -d -c lub /usr/libexec/jamid -d -c.

  3. W innym terminalu uruchom klienta, używając jami -d.

Aby odnaleźć ślad, możesz uruchomić program w GDB:

gdb -ex run --args jami -d, lub gdb -ex run --args /usr/libexec/jamid -cd, w zależności od komponentu, który ma być debugowany.

Kiedy się załama, możesz wpisać bt (lub jeszcze lepiej, thread stosować wszystkie bt) a następnie naciśnij Enter. Następnie skopiować ślad wsteczny i wklej go do numeru.

macOS

  1. Przejdź do /Aplikacji/Jami.app/Wsługa/MacOS/.

  2. Podwójne kliknięcie Jami, uruchomi się Jami i wydrukuje zapis do terminala.

  3. Kopiować zapis z terminala do pliku.

Alternatywnie można uruchomić /<path do Jami>/Jami.app/Contents/MacOS/Jami -d z terminala.

Okna

  1. Open the command prompt (cmd.exe)

  2. Run Jami.exe with the following options:

    • -d otworzyć oddzielne okno konsoli do przyjmowania dzienników

    • -f do napisania dzienników do % lokalnych danych%\jami\jami.log