Important

There is currently a small number of developers active on the project. As such, answers and tags to all opened issues are unable to be provided immediately, but the team does notice and read them. Good bug reports provide important feedback, which the team thanks you for and are always appreciated.

Указател за докладване на бъгове

Това ръководство включва стъпка по стъпка инструкции за докладване на грешки и проблеми, които срещате в Jami.

Определете средата си

  • Подгответе се за загуба на данни. Запишете профила си и свържете профила си с колкото се може повече устройства.

  • Инсталиране на най-новата версия (или дори бета версия) на Jami.

Как да докладвате бъг

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

  2. Изберете подходящия проект, за да публикувате въпроса си в:

  3. Ако имате няколко проблема, моля, подавайте отделни доклади за грешки.

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

  5. Разберете стъпките за възпроизвеждане на бъга:

    • 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. Опишете средата си, като посочите следното:

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

      • Different networks?

      • Is one or both behind NAT?

      • Are you using LTE?

      • Are you using WiFi?

    • Other details if required:

      • SIP provider,

      • Hardware,

      • etc.

Написане на ясен обобщение

Как бихте описали бъга с приблизително 10 думи? Това е първата част от вашия доклад за бъгове, който разработчик ще види.

Добрият обобщение трябва бързо и уникално да идентифицира съобщението за грешки.

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"

Написане на точни стъпки за възпроизвеждане

  • Как може разработчик да възпроизведе бъга на собствения си устройство?

    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.

  • Какво трябва да включите в доклад за бъгове?

    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.

Good

Винаги мога да възпроизведя, като следвам тези стъпки:

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.

Bad

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

Obtained result

Моля, включете:

  • Деймонът Jami (jamid или libjami или либринг) и клиента дебъгират дневниците.

  • The core dump, if one was produced.

Expected result

A description of the expected or desired behavior.

Предоставяне на допълнителна информация

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

Държебни книжа

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. Сега имате файл, съдържащ дневника на клиента.

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

Класически журнали (по подразбиране се регистрират само >= предупреждение):

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. Уверете се, че няма клиент или демони в ход: проверете, като изпълните ps aux 〇 grep jami в терминал.

    • Джами може да е още на работа, дори и да няма отворени прозорци, в зависимост от предпочитанията ви.

    • Ако клиентът или демона са в ход, прекратявайте ги с помощта на kill PID.

  2. В един терминал, започвайте демона с jamid -d -c

    • Този изпълнителен код обикновено не е в PATH, а в пакетите Debian/Trisquel/Ubuntu се намира на /usr/lib/x86_64-linux-gnu/jamid -d -c или /usr/libexec/jamid -d -c.

  3. In another terminal, start the client, using jami -d.

За да намерите обратна връзка, можете да изтеглите програмата в GDB:

gdb -ex run --args jami -d, or gdb -ex run --args /usr/libexec/jamid -cd, depending on the component you need to debug.

Когато се срива, можете да въведете bt (или още по-добре, thread прилага всички bt) след това натиснете Enter. След това копирайте обратната връзка и го впишете в броя.

macOS

  1. Навигирайте към /Applications/Jami.app/Contents/MacOS/.

  2. Двойно кликнете върху Джами, ще пусне Джами и ще отпечата дневника на терминала.

  3. Копирай дневника от терминал в файл.

В алтернативен вариант можете да изтеглите /<path до Jami>/Jami.app/Contents/MacOS/Jami -d от терминала.

Прозорци

  1. Open the command prompt (cmd.exe)

  2. Run Jami.exe with the following options:

    • -d да отвори отделно прозореца на конзолата за получаване на журнали

    • -f да пишете дневници на % локални данни%\jami\jami.log