重要

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.

虫报告指南

您在 Jami 遇到的错误和问题报告的步骤说明.

设置你的环境

  • 备份您的帐户,并将帐户连接到尽可能多的设备.

  • 报告与较早版本的错误/问题不太有用,并且更新版本可能已经修复了.

如何报告错误

  1. 如果您还没有一个帐户,请在 [Jami GitLab]https://git.jami.net/users/sign_up) 创建一个帐户.

  2. 选择合适的项目,

    • 作为一个安卓客户端,

    • 作为一个客户,

    • 作为一个客户端,

    • 作为一个 MacOS 客户端,它可以使用 MacOS 客户端,

    • The Jami project in general (or if you are not sure)

    • [如果你知道自己在做什么,你可以选择其他项目之一]https://git.jami.net)

  3. 如果您有多个问题,请单独提交错误报告.

  4. 标题是错误的明确概述 (例如:标题由于图标大小太大)

  5. 找出复制错误的步骤:

    • 如果您有精确的步骤来复制它 (很棒!)

    • 如果您可以偶尔复制,但没有遵循具体步骤,请提供有关问题的更多信息,以帮助其他人理解并尝试复制.

    • If you can not reproduce the problem, there may be little chance of it being reasonably fixable. If you do report it, please try your best to provide as much information/clues about its occurrence as possible.

  6. 确保软件更新. 理想情况下,要测试正在开发的版本,看看你的错误是否已经修复.

  7. 试图与环境隔离并复制 (即在多个设备上测试).

  8. 描述您的环境,并说明以下内容:

    • 操作系统版本

    • 精确的设备模型 (对于移动设备来说很重要)

    • 如果您正在使用Beta版本

    • what build you are using (F-Droid, Play Store, App Store, from 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 elements if needed:

      • SIP provider,

      • hardware,

      • etc.

写一个明确的概述

您将如何用大约10个单词描述 bug?这是开发人员看到的 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"

写出复制的精确步骤

  • 开发人员如何在自己的设备上复制错误?

    复制步骤是任何错误报告中最重要的部分.如果开发人员能够复制错误,则很可能会修复.如果步骤不清楚,甚至不可能知道错误是否已经修复.我们完全意识到某些错误可能看起来很明显,但它们可能与您的环境有关.您越精确,错误就会更快地修复.

  • 您应该在错误报告中包含什么?

    说明你是否可以随意复制错误,偶尔,或者根本不.除了每个步骤的意图之外,描述你与贾米互动的方法. 步骤后,准确描述观察到的 (实际) 结果和预期结果. 清楚地分开事实 (观察) 和猜测.

Good

我总是可以通过以下步骤进行繁殖:

1. Start Jami by clicking on the desktop icon
2. Start a new conversation with anyone
3. Click the file transfer icon

Expected results: A window opens and asks me to choose a file to send.
Actual results: When I click the file transfer icon, nothing happens.

Bad

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

结果

请包括:

  • 通过Jami daemon (jamid或libjami或图书) 和客户端调试日志.

  • 如果有,那么它就会被废弃.

预期结果

它描述了预期或想要的行为.

提供额外的信息

您可以节省时间,通过在预期结果下面提供此信息.

记载

基于Qt的Jami客户端 (GNU/Linux,Windows,macOS)

Go to the General settings. In the Troubleshoot section, you can click on 「Open logs」, where you will be able to get statistics (「Show stats」) or start recording information via 「Receive logs」. Then you can just copy the result and explain your scenario.

在 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客户端或恶魔实例运行:通过运行ps aux 抓 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上

  • 导航到 /应用程序/Jami.app/内容/MacOS/.

  • 双击Jami,它将启动Jami,打印到终端的日志.

  • 复制日志从终端到文件.

另一个选择是从终端运行 /<路向 Jami>/Jami.app/Contents/MacOS/Jami -d.

在安卓上

通过Jami自己收集记录:

  • 谈话

  • 按右上方的三点菜单

  • `设置

  • 击诊断记录

通过Android Debug Bridge (adb) 来通过计算机收集日志:

  • 你需要在计算机上设置ADB.

  • 发射Jami在你的智能手机上,然后执行

  • adb logcat *:D | grep `adb shell ps | egrep 'cx.ring' | cut -c10-15` > logring.txt

  • 现在你有了一个文件,包含客户的日志.

对于窗户

打开终端 (cmd.exe) 并使用以下选项启动 Jami.exe:

  • -d 开一个单独的控制台窗口,接收日志

  • -f 写日志到 %局部数据%\jami\jami.log