Важно

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.

Руководство по отчету о насекомых

В этом руководстве приведены инструкции по сообщению о ошибках и проблемах, с которыми вы столкнулись в Jami.

Создать свое окружение

• Будьте готовы к потере данных, запишите свой аккаунт и свяжите его с как можно большей частью устройств.

• Установка новейшей версии Jami (или даже бета-версии) - сообщение об ошибках/проблем по сравнению с старыми версиями менее полезно, и есть вероятность того, что они уже исправлены в более новых версиях.

Как сообщить об ошибке

0. Создайте учетную запись в [Jami GitLab]https://git.jami.net/users/sign_up) если у вас еще нет.

1. Выберите подходящий проект для размещения выпуска:

   • Клиент Android

   • Клиент Qt

   • {gitlab-project}`Клиент iOS

   • Клиент macOS (отменено с Клиент Qt)

   • Проект Jami в целом (или если вы не уверены)

   • [Если вы знаете, что делаете, вы можете выбрать один из других проектов]https://git.jami.net)

2. Если у вас есть несколько проблем, пожалуйста, подавайте отдельные отчеты об ошибках.

3. Заголовок является ясным резюме ошибки (например: панель заголовка слишком большая из-за размера иконы)

4. Выясните шаги воспроизведения ошибки:

   • Если у вас есть точные шаги для воспроизведения (отлично!) вы на пути к созданию полезного отчета об ошибках.

   • Если вы можете периодически повторять, но не после выполнения конкретных шагов, пожалуйста, предоставьте дополнительную информацию о проблеме, чтобы помочь другим понять и попробовать повторить ее.

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

5. Убедитесь, что ваш программный обеспечение обновлено.

6. Постарайтесь изолировать от окружающей среды и воспроизводить (т. е. тестировать на нескольких устройствах).

7. Опишите свое окружение, указав следующее:

   • Версия ОС

   • точная модель устройства (важная для мобильных устройств)

   • если вы используете бета-версию

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

     • аппаратное обеспечение,

     • и т. д.

Написать четкое резюме

Как бы вы описали ошибку, используя примерно 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"

Написание точных шагов воспроизводства

• Как разработчик может воспроизвести эту ошибку на своем устройстве?

  Если разработчик способен воспроизвести ошибку, то, скорее всего, она будет исправлена. Если этапы не ясны, то даже невозможно узнать, исправлена ли ошибка. Мы полностью осознаем, что некоторые ошибки могут казаться очевидными для вас, но они, вероятно, связаны с вашей средой. Чем точнее вы, тем быстрее ошибка может быть исправлена.

• Что нужно включить в отчет о ошибках?

  Укажите, можете ли вы воспроизводить ошибку по своему усмотрению, время от времени или вообще не можете. Опишите свой метод взаимодействия с Jami помимо намерения каждого шага. После ваших шагов, точно опишите наблюдаемый (действительный) результат и ожидаемый результат.

Хорошо

Я всегда могу воспроизводить следуя этим шагам:

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.

Плохо

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

Полученный результат

Пожалуйста, включите:

• Дэймон Jami (jamid или libjami или либринг) и клиент дебгуруют журналы.

• Ядрень, если он был произведен.

Ожидаемый результат

Это описание ожидаемого или желаемого поведения.

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

Для большинства сообщений об ошибках требуется следующая информация.

Логографические

Клиент Jami на базе 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.

На GNU/Linux

Классические журналы (по умолчанию записываются только >= предупреждения):

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

Полный журнал: поскольку клиент Jami (GUI) и демона являются отдельными процессами, самый простой способ получить журналы из обоих - запустить их один за другим, вручную.

1. Убедитесь, что никаких клиента Jami или демонов не работает: проверьте, запуская ps aux ̶, загружая 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

• Перейти к /Applications/Jami.app/Contents/MacOS/.

• Двойной нажмите Jami, и он запустит Jami и отпечатает журнал на терминал.

• Копируйте журнал из терминала в файл.

В качестве альтернативы, вы можете запустить /<path к Jami>/Jami.app/Contents/MacOS/Jami -d с терминала.

На Android

Чтобы собрать журналы через ваш телефон, используя саму Джами:

• Нажмите Собщения

• Нажмите на меню с тремя точками в правом верхнем углу

• Нажмите на Статы

• Нажмите Дагностические записи

Чтобы собрать журналы с помощью компьютера с помощью моста Android Debug Bridge (adb):

• Вам нужно установить AdB на вашем компьютере.

• Запустите Jami на свой смартфон и затем выполнить

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

• У вас теперь есть файл, содержащий дневник клиента.

Для окон

Откройте терминал (cmd.exe) и запустить Jami.exe с следующими опциями:

• -d открыть отдельное окно консоли для получения журналов

• -f для записи журналов в % локальных данных%\jami\jami.log