Importante

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.

Guida per la segnalazione di insetti

Questa guida include istruzioni passo dopo passo per segnalare bug e problemi che si incontrano a Jami.

Imposta il tuo ambiente

• Preparati per la perdita dei dati.

• Installare l’ultima versione (o anche una versione beta) di Jami. segnalare bug/problemi rispetto alle versioni precedenti è meno utile e c’è la probabilità che sia già stato risolto nelle versioni più recenti.

Come segnalare un bug

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

1. Scegli il progetto giusto per pubblicare il tuo numero in:

   • 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. Se avete più problemi, per favore, presentate segrete segnalazioni di bug. Sarà molto più facile tenere traccia di loro in questo modo.

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

4. Scopri i passaggi per riprodurre il bug:

   • 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. Descrivi il tuo ambiente (s) specificando quanto segue:

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

Scrivere una sintesi chiara

Come descriverebbe il bug utilizzando circa 10 parole? Questa è la prima parte del tuo rapporto di bug che un sviluppatore vedrà.

Un buon riassunto dovrebbe identificare rapidamente e in modo unico un rapporto di bug.

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"

Scrivere passi precisi per riprodursi

• Come può uno sviluppatore riprodurre il bug sul proprio dispositivo?

  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.

• Cosa dovrebbe includere un rapporto di bug?

  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

Posso sempre riprodurmi seguendo questi passaggi:

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

Si prega di includere:

• Il daemon Jami (jamid o libjami o libring) e i log di debug del cliente.

• The core dump, if one was produced.

Expected result

A description of the expected or desired behavior.

Fornire informazioni supplementari

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

Reggi

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. Ora hai un file contenente il registro del cliente

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

Registri classici (per impostazione predefinita sono registrati solo >= avvertimenti):

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. Assicurarsi che nessun client Jami o istanza di daemon si eseguono: controllare eseguendo ps aux 〇 grep jami in un terminal.

   • Jami potrebbe ancora funzionare anche se non ci sono finestre aperte, a seconda delle tue preferenze.

   • Se il client o il daemon sono in esecuzione, chiudilo utilizzando kill PID.

2. In un terminale, inizia il daemon con jamid -d -c

   • Questo eseguibile non è normalmente presente nel PATH, e nei pacchetti Debian/Trisquel/Ubuntu, si trova a /usr/lib/x86_64-linux-gnu/jamid -d -c o /usr/libexec/jamid -d -c.

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

Per avere una traccia, puoi eseguire il programma all’interno del GDB:

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

Quando si incresca, è possibile digitare bt (o meglio, thread applicare tutti bt) quindi premere Enter.

macOS

1. Navigare su /Applications/Jami.app/Content/MacOS/.

2. Fare doppio clic su Jami, lancerà Jami e stampa il registro al terminal.

3. Copia il registro dal terminal in un file.

In alternativa, puoi eseguire /<path to Jami>/Jami.app/Contents/MacOS/Jami -d dal terminal.

Windows

1. Open the command prompt (cmd.exe)

2. Run Jami.exe with the following options:

   • -d per aprire una finestra separata della console per ricevere i registri

   • -f scrivere log a %localappdata%\jami\jami.log