Tärkeä

Projektissa on pieni määrä kehittäjiä. Tästä johtuen kaikkien avoinna olevien ongelmien vastauksia ei voida antaa välittömästi, mutta tiimi huomaa ja lukee ne. Hyvät bugiraportit antavat tärkeää palautetta, josta tiimi kiittää ja arvostetaan aina.

Virheilmoitusopas

Tämä opas sisältää ohjeet sinun Jamissa kohdattujen virheiden ja ongelmien ilmoittamiseen.

Määritä käyttöympäristösi

• Varaudu tietojen katoamiseen. Varmuuskopioi tilisi ja linkitä tilisi mahdollisimman moneen laitteeseen.

• Asenna Jamin uusin versio (jopa beta-versio). Vanhempien versioiden virheistä/ongelmista ilmoittaminen on vähemmän hyödyllistä, sillä on todennäköistä, että ne on jo korjattu uudemmissa versioissa.

Kuinka ilmoittaa bugista

0. Aluksi: Luo tili Jami GitLab.

1. Valitse oikea projekti, johon haluat kertoa bugista:

   • The Jami client for Android (Jami Android- ja Android TV -laitteille)

   • The Jami client for iOS (Jami iPhone- ja iPad-laitteille)

   • The desktop Jami client (Jami Qt-kehitysversio, GNU/Linux-, macOS- ja Windows)

   • Jos tiedät mitä teet, voit valita jonkin muista projekteista

2. Jos sinulla on useita ongelmia, tee erilliset vikailmoitukset. Näin niiden seuraaminen on helpompaa.

3. Otsikko on selkeä kuvaus virheestä (esim. the header bar is too big due to icon size).

4. Kerro ohjeet bugin toistamiseksi:

   • Jos sinulla on ohjeet bugin toistamiseen (hienoa!), olet tekemässä hyödyllistä vikailmoitusta.

   • Jos pystyt joskus toistamaan bugin, mutta et tiettyjen vaiheiden jälkeen, anna lisätietoja, jotta muut ymmärtävät ja voivat yrittää toistaa sen.

   • Jos et pysty toistamaan bugia, sen korjaaminen on epätodennäköistä. Jos ilmoitat siitä, anna mahdollisimman paljon tietoa/vihjeitä sen esiintymisestä.

5. Varmista, että ohjelmistosi on ajan tasalla. Ihannetapauksessa testaa kehitysvaiheessa olevaa versiota nähdäksesi, onko virhe jo korjattu.

6. Yritä toistaa eri ympäristöissä (eli testata useilla laitteilla).

7. Kuvaile sinun ympäristö(t) antamalla seuraavat tiedot:

   • Käyttöjärjestelmä ja versio

   • Tarkka laitemalli (tärkeä mobiililaitteilla)

   • Jamin vakaa vai beta-versio

   • Mitä alustaa käytät (F-Droid, Google Play, App Store, dl.jami.net, jne.). Jos olet rakentanut oman version Jamista, ilmoita tarkka Jami daemon -versio ja ohjelman versio (voit tarkistaa sen komennoilla jamid -v ja jami -v; pakettejamme päivitetään melko usein).

   • Lähiverkon toiminta:

     • Ovatko molemmat laitteet samassa lähiverkossa?

     • Eri verkot?

     • Onko toinen vai molemmat NAT:n takana?

     • Käytätkö LTE:tä?

     • Käytätkö Wifi:ä?

   • Muita tietoja tarvittaessa:

     • SIP-palveluntarjoaja,

     • Laitteisto,

     • jne.

Selkeän koosteen kirjoittaminen

Kuvaile bugia noin kymmenellä sanalla? Tämä on bugiraporttisi ensimmäinen osa, jonka kehittäjä näkee.

Hyvän koosteen tulisi kuvata nopeasti vian laatu. Sen tulisi selittää ongelma, ei ehdottamaasi ratkaisua.

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"

Kirjoita tarkat vaiheet

• Miten kehittäjä voi toistaa virheen omalla laitteellaan?

  Virheen toistamisen vaiheet on tärkein osa virheraporttia. Jos kehittäjä pystyy toistamaan virheen, se todennäköisesti korjataan. Jos vaiheet ovat epäselviä niin on mahdollista tietää, onko virhe korjattu. Jotkut virheet saattavat näyttää itsestäänselvyyksiltä, ​​mutta ne voi liittyä ympäristöösi. Mitä tarkempi olet, sitä nopeammin virhe voidaan korjata.

• Mitä vikailmoitukseen tulisi sisällyttää?

  Ilmoita, voitko toistaa virheen halutessasi, satunnaisesti vai et ollenkaan. Kuvaile sinun Jamin käyttö, sekä kunkin vaiheen tarkoitus. Kuvaile tarkasti havaittu (todellinen) tulos ja odotettu tulos. Erota faktat (havainnot) selvästi spekulaatioista.

Hyvä.

Voin aina tehdä sen noudattamalla näitä ohjeita:

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.

Huono:

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

Saatu tulos

Lisää seuraavat tiedot:

• Jami-daemon (jamid, libjami tai libring) ja ohjelman virhelokit.

• Vedos, jos sellainen tuotettiin.

Odotettu tulos

Kuvaus odotetusta tai halutusta käyttäytymisestä.

Lisätietojen antaminen

Useimmissa vikailmoituksissa pyydetään seuraavia tietoja. Voit säästää aikaa antamalla nämä tiedot odotettujen tulosten alapuolella.

Lokit

Android

Androidlokien kerääminen Jamin avulla:

1. Paina Keskustelut.

2. Paina oikeassa yläkulmassa ⋮ (kolme pistettä).

3. Paina Asetukset.

4. Paina Diagnostiikka ja lokit.

Lokien kerääminen tietokoneen kautta käyttämällä Android Debug Bridge (adb):

1. Sinun täytyy asentaa adb tietokoneellesi.

2. Käynnistä Jami puhelimellasi ja suorita sitten adb logcat *:D | grep `adb shell ps | egrep 'cx.ring' | cut -c10-15` > logring.txt

3. Sinulla on nyt tiedosto, joka sisältää lokin

Qt-pohjainen Jami-ohjelma (GNU/Linux, macOS, Windows)

1. Avaa asetuksista Yleiset-välilehti.

2. Paina Vianmääritys Avaa lokit -painiketta.

3. Siirrä Näytä lokit -vipu käyttöön.

4. Paina Kopioi-painiketta.

5. Liitä tulokset ja selitä ongelmaan liittyvä skenaario.

GNU/Linux

Klassiset lokit (oletuksena vain varoituslokit):

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

Täydellinen loki: Jami-ohjelma (GUI) ja demoni ovat erillisiä prosesseja. Saadaksesi lokit molemmista, käynnistä kukin prosessi käsin yksi kerrallaan.

1. Varmista, ettei Jami-ohjelma tai daemon-instansseja ole käynnissä: tarkista tämä suorittamalla ”ps aux | grep jami” terminaalissa.

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

   • Jos ohjelma tai daemon on käynnissä, lopeta ne käyttämällä ”kill PID”-komentoa.

2. Terminaalissa käynnistä daemon komennolla ”jamid -d -c”

   • Tätä suoritettava tiedosto ei yleensä löydy polusta ”PATH” ja Debian/Trisquel/Ubuntu-paketeissa se sijaitsee hakemistossa ”/usr/lib/x86_64-linux-gnu/jamid -d -c” tai ”/usr/libexec/jamid -d -c”.

3. Käynnistä ohjelma toisessa terminaalissa komennolla ”jami -d”.

Saadaksesi backtrace:in, voit suorittaa ohjelman GDB:n sisällä:

”gdb -ex run –args jami -d”, tai ”gdb -ex run –args /usr/libexec/jamid -cd”, riippuen komponentista, jonka haluat korjata.

Jos se kaatuu, voit kirjoittaa ”bt” (tai parempi, ”thread apply all bt”) ja painaa sitten Enter. Kopioi sitten jäljitys ja liitä se ongelmaan.

macOS

1. Selaa polkuun ”/Applications/Jami.app/Contents/MacOS/”.

2. Paina Jamia kahdesti. Se käynnistää Jamin ja tulostaa lokin terminaaliin.

3. Kopioi loki terminaalista tiedostoon.

Vaihtoehtoisesti voit suorittaa ”//Jami.app/Contents/MacOS/Jami -d” terminaalissa.

Windows

1. Avaa komentokehote (cmd.exe)

2. Suorita ”Jami.exe” seuraavilla vaihtoehdoilla:

   • ”-d” avaa erillisen cmd-ikkunan lokien vastaanottamista varten

   • ”-f” kirjoittaaksesi lokit tiedostoon ”%localappdata%\jami\jami.log”