Tärkeä

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.

Käsittelijä

Tässä oppaassa on ohjeet sammakohtaista virheiden ja ongelmien raportointia varten Jami:ssä.

Aseta ympäristösi

• Varmista, että tiedot menettävät, varmista tiliesi varmuuskopiointi ja yhdistä tili mahdollisimman monen laitteen kanssa.

• Jos on olemassa jo uusi versio, on todennäköistä, että se on korjattu uusemmilla versioilla.

Miten raportoida hyönteinen

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

1. Valitse oikea projekti julkaistaaksesi numerosi:

   • The Jami client for Android (Jami client for Android and Android TV devices)

   • The Jami client for iOS (Jami client for iPhone and iPad devices)

   • The desktop Jami client (Jami client, based on the Qt framework, for GNU/Linux, macOS, and Windows platforms)

   • If you know what you are doing, you may choose one of the other projects

2. Jos sinulla on useita ongelmia, toimita erilliset virta-ilmoitukset.

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

4. Kertokaa virheen palauttamista varten tehtävät:

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

5. Ensure your software is up to date. Ideally, test an in-development version to see whether your bug has already been fixed.

6. Attempt to isolate from the environment and reproduce (that is, test on multiple devices).

7. Kuvaile ympäristösi määrittelemällä seuraavat:

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

Kirjoittaminen selkeää yhteenvetoa

Miten kuvailisit virheen noin 10 sanalla? Tämä on ensimmäinen osa virheen raporttia, jonka kehittäjä näkee.

Hyvä yhteenveto tulee tunnistaa virheen raportin nopeasti ja ainutlaatuisesti.

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"

Kirjoittaminen tarkkaista reprodukttiohjeita

• Miten kehittäjä voi tuottaa virheen omalle laitteelleen?

  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.

• Mitä pitäisi sisällyttää virta-ilmoitukseen?

  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

Voin aina lisääntyä seuraavan askeleen avulla:

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

Lisää seuraavat tiedot:

• Jami daemon (jamid tai libjami tai libring) ja asiakas debug logit.

• The core dump, if one was produced.

Expected result

A description of the expected or desired behavior.

Lisätietojen antaminen

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

Pöytäkirjat

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. Sinulla on nyt tiedosto, jossa on asiakkaan kirjaus.

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

Klassikko-ilmoitukset (erikoisesti vain >= varoitusilmoitukset kirjautuvat):

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. Varmista, ettei Jami-asiakas tai demoni-tapahtuma ole käynnissä: tarkista käyttämällä ps aux ‧ grap jami terminaalissa.

   • Jami saattaa yhä toimia, vaikka ikkunat eivät ole auki.

   • Jos joko asiakas tai demoni on käynnissä, lopeta ne käyttämällä kill PID.

2. Yksi terminaali alkaa daemon kanssa jamid -d -c

   • Tämä suoritettavissa oleva ei yleensä ole PATH, ja Debian/Trisquel/Ubuntu-paketteissa se sijaitsee /usr/lib/x86_64-linux-gnu/jamid -d -c tai /usr/libexec/jamid -d -c.

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

Jotta löydät jäljet, voit käyttää ohjelmaa GDB:ssä:

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

Kun se hajoaa, voit kirjoittaa bt (tai vielä parempi, thread soveltaa kaikki bt) ja painaa Enter.

macOS

1. Käytä /Applications/Jami.app/Contents/MacOS/.

2. Jos klikkaa kaksi kertaa Jamiä, se käynnistää Jamiä ja tulostaa login terminaaliin.

3. Kopioida päiväkirja terminaalista tiedostoon.

Vaihtoehtoisesti voit käyttää /<tie Jami>/Jami.app/Contents/MacOS/Jami -d terminaalista.

Ikkunat

1. Open the command prompt (cmd.exe)

2. Run Jami.exe with the following options:

   • -d avata erillinen kontolin ikkuna vastaanottamaan logit

   • -f kirjoittaa logit %localappdata%\jami\jami.log