(deprecated by {gitlab-project}`the Qt client <jami-client-qt>`)
- {gitlab-project}`The Jami project in general (or if you are not
sure) <jami-project>`
-[If you know what you are doing you may choose one of the other
projects](https://git.jami.net)
* {gitlab-project}`The Jami project in general (or if you are not sure) <jami-project>`
*[If you know what you are doing you may choose one of the other projects](https://git.jami.net)
2. If you have multiple issues, please file separate bug reports.
It will be much easier to keep track of them that way.
...
...
@@ -45,16 +39,10 @@ one already.
too big due to icon size)
4. Figure out the steps to reproduce the 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 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 try your best
to provide as much information/clues about its occurrence as
possible.
* If you have precise steps to reproduce it (great!) you're on your way to creating a helpful bug report.
* If you can reproduce 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 try your best to provide as much information/clues about its occurrence as possible.
5. Make sure your software is up to date. Ideally, test an
in-development version to see whether your bug has already been fixed.
...
...
@@ -63,22 +51,24 @@ one already.
multiple devices).
7. Describe your environment(s) by specifying the following:
- OS version
- precise device model (important for mobile devices)
- if you are using a beta version
- 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`;
* OS version
* precise device model (important for mobile devices)
* if you are using a beta version
* 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.
Writing a clear summary
-----------------------
* 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.
## Writing a clear summary
How would you describe the bug using approximately 10 words?
This is the first part of your bug report a developer will see.
...
...
@@ -96,10 +86,9 @@ Good: "All calls hang up after 32 seconds"
Bad: "Not able to call my friends"
```
Writing precise steps to reproduce
----------------------------------
## Writing precise steps to reproduce
- How can a developer reproduce the bug on his or her own device?
* How can a developer reproduce the bug on his or her own device?
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
...
...
@@ -109,7 +98,7 @@ Writing precise steps to reproduce
related to your environment. The more precise you are, the quicker
the bug can be fixed.
- What should you include in a bug report?
* What should you include in a bug report?
Indicate whether you can reproduce the bug at will, occasionally,
or not at all. Describe your method of interacting with Jami in
...
...
@@ -117,42 +106,38 @@ Writing precise steps to reproduce
describe the observed (actual) result and the expected result.
Clearly separate facts (observations) from speculations.
### Good :
### Good
I can always reproduce by following these steps:
```
<pre>
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.
```
</pre>
### Bad :
### Bad
```
Try to transfer a file
<pre>
Try to transfer a file.
It doesn't work.
```
</pre>
Obtained Result
---------------
## Obtained Result
Please include:
+ The Jami daemon (jamid or libjami or libring) and client debug logs.
+ The core dump if one was produced.
* The Jami daemon (jamid or libjami or libring) and client debug logs.
* The core dump if one was produced.
Expected Result
---------------
## Expected Result
It's a description of expected or desired behavior.
Providing additional information
--------------------------------
## Providing additional information
The following information is requested for most bug reports. You can
save time by providing this information below the Expected results.
...
...
@@ -161,9 +146,8 @@ save time by providing this information below the Expected results.
#### Qt-based Jami client (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".
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.
