|
|
# How to report a bug or ask for a new feature
|
|
|
|
|
|
Found a bug? Need an enhancement? Issues are for you! Issues are one of the main tools we use to develop Gajim. Here you can learn how to open a good issue. It makes our work easier and faster.
|
|
|
Found a bug? Need an enhancement? Our issue tracker is the right tool for you! Issues are one of the main tools we use to develop Gajim. Here you can learn about how to open an issue. It makes our work easier and faster.
|
|
|
|
|
|
## What is an issue?
|
|
|
|
|
|
An issue is a simple report.
|
|
|
Issues are useful for developers because they show us what users want, and what bugs they have.
|
|
|
Issues are useful for developers because they show us what users want, and what bugs they are experiencing while using Gajim.
|
|
|
|
|
|
## Why should I open an issue?
|
|
|
|
... | ... | @@ -34,8 +34,19 @@ A *short* title covering the subject |
|
|
|
|
|
### Description
|
|
|
|
|
|
In a few words, explain why you opened this issue. You can chose from the templates if it is a bug you are reporting, or if it is an enhancement you are proposing (new feature, improvement). Use these templates, they will guide you and ask you for all the infos necessary. Be precise and complete.
|
|
|
In a few words, explain why you opened this issue. You can chose from the templates if it is a bug you are reporting, or if it is an enhancement you are proposing (new feature, improvement). Use these templates, they will guide you and ask you for all the infos necessary. Be precise and complete. Sometimes it might be necessary to gather additional info to supply a helpful issue (see next section).
|
|
|
|
|
|
## Gathering information
|
|
|
|
|
|
Sometimes there is no traceback for you to copy, sometimes Gajim might act strange and you'd like to know why. At this point logging helps to find out why.
|
|
|
|
|
|
*Windows*
|
|
|
|
|
|
Gajim is able to store log internals to a file. To do this, you have to start Gajim as follows:
|
|
|
|
|
|
`gajim-debug.exe > "C:\temp\gajim-debug.log" 2>&1`
|
|
|
|
|
|
As soon as a crash (or undesired behaviour) occurs, look for the log file and attach it to the issue you are opening.
|
|
|
|
|
|
## After that
|
|
|
|
... | ... | |