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. Tworzyć konto w [Jami GitLab]https://git.jami.net/users/sign_up) jeśli nie masz już jednego.

  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. Tytuł jest wyraźnym podsumowaniem błędu (np. paska nagłówka jest zbyt duża ze względu na rozmiar ikony)

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

    • Jeśli masz precyzyjne kroki do odtworzenia (wyśmienite!) jesteś w drodze do stworzenia pomocnego raportu o błędach.

    • Jeśli możesz czasami odtwarzać, ale nie po wykonaniu określonych kroków, proszę podać dodatkowe informacje na temat problemu, aby pomóc innym zrozumieć i spróbować go odtwarzać.

    • 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. Upewnij się, że oprogramowanie jest aktualne.

  7. Spróbuj izolować się od środowiska i rozmnażać (tj. testować na wielu urządzeniach).

  8. Opisz swoje środowisko (s) podając następujące informacje:

    • Wersja systemu operacyjnego

    • precyzyjny model urządzenia (istotny dla urządzeń mobilnych)

    • jeśli używasz wersji beta

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

    • stan sieci:

      • czy oba urządzenia są w tej samej, lokalnej sieci?

      • Inne sieci?

      • Jedno lub oba za NAT’em?

      • Używasz LTE?

      • Używasz WiFi?

    • inne elementy, jeśli wymagane:

      • Dostawca SIP,

      • sprzęt,

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

    Jeśli programista jest w stanie odtworzyć błąd, jest bardzo prawdopodobne, że zostanie naprawiony. Jeśli kroki nie są jasne, może nawet nie być możliwe, aby wiedzieć, czy błąd został naprawiony. Jesteśmy całkowicie świadomi, że niektóre błąd mogą wydawać się oczywiste dla Ciebie, ale prawdopodobnie są związane z Twoim otoczeniem. Im bardziej precyzyjne jesteś, tym szybciej można naprawić błąd.

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

    Wyznacz, czy możesz odtworzyć błąd w miarę woli, czasami, czy w ogóle. Opisz swoją metodę interakcji z Jami oprócz intencji każdego kroku. Po swoich krokach, dokładnie opisz obserwowany (skuteczny) wynik i oczekiwany wynik.

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

Złe

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

Dyskutowany wynik

Proszę włączyć:

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

  • Wystarczy, że byłby wyprodukowany.

Oczekiwany wynik

To opis oczekiwanego lub pożądanej zachowania.

Dostarczanie dodatkowych informacji

W przypadku większości zgłoszeń błędów wymagane są następujące informacje.

Płoty

Klient Jami oparty na Qt (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.

Na GNU/Linux

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

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

Pełny log: Ponieważ klient Jami (GUI) i daemon są oddzielnymi procesami, najłatwiejszym sposobem uzyskania logów z obu jest uruchomienie ich jeden po drugim, ręcznie.

  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.

Na macOS

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

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

  • Kopiować zapis z terminala do pliku.

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

Na Androida

Aby zebrać zapisy przez telefon, używając samego Jami:

  • Kliknij Konwersacje

  • Naciskaj menu z trzema punktami w górnej prawej części

  • Wykorzystaj Ustawienia

  • Kliknij Diagnostyczne zapisy

Aby zebrać zapisy za pośrednictwem komputera za pomocą mostu Android Debug Bridge (adb):

  • Musisz mieć na komputerze ustawione adb.

  • Uruchom Jami na smartfonie i wykonaj

  • ```db logcat *:D ♬ grap adb shell ps ♬ egrep 'cx.ring' ♬ cut -c10-15d > logring.txt``

  • Masz teraz plik zawierający zapisy klienta

W przypadku Windows

Otwórz terminal (cmd.exe) i uruchomij Jami.exe z następującymi opcjami:

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

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