Important

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. Изберете подходящия проект, за да публикувате въпроса си в:

   • {gitlab-проект}Андроид клиент <jami-клиент-android>

   • {gitlab-проект}Клиентът на Qt <jami-client-qt>

   • {gitlab-проект}`IOS клиент

   • MacOS клиент (отменен от Qt клиент)

   • {gitlab-проект}Проектът Jami като цяло (или ако не сте сигурни) <jami-проект>

   • [Ако знаете какво правите, можете да изберете един от другите проекти]

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,

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

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

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

  Ако разработчикът е в състояние да възпроизведе грешката, то е много вероятно грешката да бъде поправяна. Ако стъпките не са ясни, може би дори не е възможно да се знае дали грешката е била поправяна. Ние напълно знаем, че някои грешки могат да изглеждат очевидни за вас, но те вероятно са свързани с вашата среда.

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

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

Good

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

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.

Получен резултат

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

• Деймонът 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

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

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

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

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

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

На Android

За да събираш дневници чрез телефона си, използвайки самото Jami:

• Натиснете Съртието

• Натиснете върху менюто с три точки в горната десна част

• Натиснете Стоите

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

За събиране на журнали чрез компютъра си с помощта на Android Debug Bridge (adb):

• Трябва да имаш AdB на компютъра си.

• Изпрати Джами на смартфона си и след това изпълни

• ```

• Сега имате файл, съдържащ дневника на клиента.

За Windows

Отворете терминал (cmd.exe) и стартирайте Jami.exe с следните опции:

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

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