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.

Guia de informes de bugs

Aquesta guia inclou instruccions pas a pas per informar bugs i problemes que trobis a Jami.

Configura el teu entorn

  • Prepara-te per a la pèrdua de dades.

  • Installa la versió més recent (o fins i tot una versió beta) de Jami. La denuncia de bugs/problemes contra versions anteriors és menys útil, i hi ha una probabilitat que ja hagi estat arreglat en versions més noves.

Com denunciar un bug

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

  2. Seleccioneu el projecte adequat per publicar el vostre tema en:

  3. Si tens múltiples problemes, por favor, presenta informes separats de bugs. serà molt més fàcil mantenir un seguit d’ells d’aquesta manera.

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

  5. Descobreix els passos per reproduir el 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.

  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. Descriu el vostre entorn (s) especificant el següent:

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

Escriure un resum clar

Com descriuria el bug utilitzant aproximadament 10 paraules? Aquesta és la primera part del seu informe de bug que un desenvolupador veurà.

Un bon resum ha de identificar ràpidament i de manera única un informe de bugs. Ha d’explicar el problema, no la solució suggestada.

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"

Escriure passos precisos per reproduir

  • Com pot reproduir el bug en el seu dispositiu?

    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.

  • Què hauries d’incloure en un informe de bugs?

    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

Sempre puc reproduir seguint aquests passos:

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

Incloure:

  • El daemon Jami (jamid o libjami o libring) i els registres de depurament del client.

  • The core dump, if one was produced.

Expected result

A description of the expected or desired behavior.

Proporcionar informació addicional

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

Enregistrament

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. Ara tens un fitxer que conté el registre del client

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

Els registres clàssics (per defecte només s’inscriuen registres >= advertencia):

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. Asegurar que cap client Jami o instàncies de demó està funcionant: comprovar executant ps aux ‧ grap jami en una terminal.

    • Jami pot continuar funcionant fins i tot si no hi ha finestres obertes, depenent de les teves preferències.

    • Si un client o un demó estan funcionant, acabar amb ells utilitzant kill PID.

  2. En una terminal, començar el daemon amb jamid -d -c

    • Aquest executable normalment no està en el PATH, i en els paquets Debian/Trisquel/Ubuntu, es troba 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 aconseguir un rastre, pots executar el programa dins de GDB:

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

Quan es trenca, pots escriure bt (o encara millor, thread aplicar tots bt) i després premir Enter. Després copiar el retroces i col·locar-lo en el número.

macOS

  1. Navegar a /Applications/Jami.app/Contents/MacOS/.

  2. Doble clic Jami, que llançarà Jami i imprimirà el registre a la terminal.

  3. Copia el registre de la terminal a un fitxer.

Alternativament, pots executar /<path a Jami>/Jami.app/Contents/MacOS/Jami -d des de la terminal.

Finestres

  1. Open the command prompt (cmd.exe)

  2. Run Jami.exe with the following options:

    • -d per obrir una finestra de consola separada per rebre registres

    • -f per escriure registres a %localappdata%\jami\jami.log