중요

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.

버그 보고 안내서

이 가이드에는 Jami에서 발생하는 버그와 문제를 보고하는 단계별 지침이 포함되어 있습니다.

환경 을 설정 하십시오

  • 데이터 손실에 대비해 계정을 백업하고 가능한 많은 장치에 연결하십시오.

  • Jami의 최신 버전 (또는 베타 버전) 을 설치하십시오. 이전 버전과 비교하여 버그/문제를 보고하는 것은 덜 유용하며, 더 새로운 버전에서 이미 수정되었을 가능성이 있습니다.

버그 보고 방법

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

  2. 다음 문서에 해당 내용을 게시하기 위해 적절한 프로젝트를 선택하세요.

  3. 여러 가지 문제가 있는 경우 별도의 버그 보고서를 제출하시기 바랍니다. 그렇게 하면 그들을 추적하는 것이 훨씬 쉬워질 것입니다.

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

  5. 버그를 복제하기 위한 단계를 알아보십시오.

    • 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. 다음을 지정하여 자신의 환경을 설명하십시오.

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

명확한 요약을 작성하는 것

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

복제 하기 위한 정확한 단계를 작성

  • 개발자가 어떻게 자신의 기기에서 버그를 복제할 수 있습니까?

    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.

  • 버그 보고서에 무엇을 포함해야 합니까?

    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

저는 항상 다음 단계를 따라 재생산 할 수 있습니다.

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

다음을 포함해 주십시오.

  • 자미 데몬 (자미드 또는 리바지 또는 리브링) 및 클라이언트 디버깅 로그

  • The core dump, if one was produced.

Expected result

A description of the expected or desired behavior.

추가 정보 제공

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

로그

안드로이드

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. 이제 클라이언트의 로그를 담은 파일이 있습니다.

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

클래식 로그 (전설 로그만 >= 경고 로그만 기록됩니다):

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

  1. /Applications/Jami.app/Contents/MacOS/로 이동합니다.

  2. 자미를 두 번 클릭하면 자미를 발사하고 터미널에 로그를 인쇄합니다.

  3. 터미널에서 로그를 파일로 복사합니다.

이 경우 /<길을 Jami>/Jami.app/Contents/MacOS/Jami -d로 실행할 수 있습니다.

창문

  1. Open the command prompt (cmd.exe)

  2. Run Jami.exe with the following options:

    • -d 로그를 수신하기 위해 별도의 콘솔 창을 열기

    • -f 로그를 % 로컬ppdata%\jami\jami.log로 작성하기