|
|
[[PageOutline]]
|
|
|
# How to report a bug or ask for a new feature
|
|
|
|
|
|
<img src="http://trac.gajim.org/attachment/wiki/HowToCreateATicket/tango-document-new.png?format=raw" style="vertical-align:middle; margin-right:10px; float:left;" alt="NewTicket" /> <em>Found a bug? Need an enhancement? Tickets are for you! Tickets are one of the main tools we use to develop Gajim. Here you can learn how to create a good ticket. It makes our work easier and faster.</em></p><div style="clear:left;"></div>
|
|
|
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.
|
|
|
|
|
|
## What is a ticket?
|
|
|
## What is an issue?
|
|
|
|
|
|
A ticket is a simple report.
|
|
|
Tickets are useful for developers because it is the place they can see what users want, and what bugs they have.
|
|
|
An issue is a simple report.
|
|
|
Issues are useful for developers because they show us what users want, and what bugs they have.
|
|
|
|
|
|
## Why should I create a ticket?
|
|
|
## Why should I open an issue?
|
|
|
|
|
|
You can create a ticket for:
|
|
|
* Reporting a bug (*NOTE:* If you have a segfault please read [this](./ReportingSegfault) before reporting).
|
|
|
* Ask a new feature
|
|
|
You can open an issue to:
|
|
|
* Report a bug (*NOTE:* If you have a segfault please read [this](./ReportingSegfault) before reporting).
|
|
|
* Ask for a new feature
|
|
|
* Add a task
|
|
|
|
|
|
## Before creating
|
|
|
## Before opening
|
|
|
|
|
|
Before posting, you must check that such a ticket haven't already been posted.
|
|
|
Before opening a new issue, you should check if there already is an open issue regarding your problem or idea.
|
|
|
|
|
|
*How can I check if somebody else created such a ticket before?*
|
|
|
You can search the list of open issues for [Gajim](https://dev.gajim.org/gajim/gajim/issues?sort=created_date&state=opened) and [Gajim Plugins](https://dev.gajim.org/gajim/gajim-plugins?sort=created_date&state=opened) or the [Website](https://dev.gajim.org/gajim/website/issues?sort=created_date&state=opened).
|
|
|
|
|
|
*Please use these links* to have a look if someone else already had the same problem/idea:
|
|
|
* [report:1 open tickets that need to be fixed]
|
|
|
* bugs (including closed) by modules:
|
|
|
* [query:component=chat chat window], [query:component=dialogs dialogs], [query:component=preferences preferences], [query:component=roster roster (main window)], [query:component=xmpppy xmpppy (core)], ...
|
|
|
* ... select the component matching your problem/idea and press update
|
|
|
* [query:component=None uncategorized tickets]
|
|
|
*Please make use of the search functionality to avoid duplicates!*
|
|
|
|
|
|
You can also do a [/query Ticket Query]...
|
|
|
## Where can I open an issue?
|
|
|
|
|
|
|
|
|
## Where can I create a ticket?
|
|
|
|
|
|
You need to [/login log in] or to [/register register an account] to be able to create a ticket. Then fill [/newticket this form].
|
|
|
You need to [log in](https://dev.gajim.org/users/sign_in) or [register an account](https://dev.gajim.org/users/sign_in#register-pane) to be able to open an issue. Then you can open a new issue with the "New Issue" button.
|
|
|
|
|
|
## How should I fill in the form?
|
|
|
|
|
|
You have several information to give to create a new ticket.
|
|
|
|
|
|
### Your e-mail or username
|
|
|
|
|
|
This field is used to know who reported the ticket. It is beter to speak to someone than to speak with an anonymous, isn't it?
|
|
|
|
|
|
### Short summary
|
|
|
|
|
|
In a few words, explain why you created this ticket. It is used in tickets lists, rss feeds, and others.
|
|
|
|
|
|
### Type
|
|
|
|
|
|
It is what is you ticket about.
|
|
|
* *Defect:* use it for Gajim bugs; if there is a problem.
|
|
|
* *Enhancement:* use it if you're asking for a new feature, an improvement of Gajim
|
|
|
* *Task:* use it if you have some work which isn't a new feature or an enhancement.
|
|
|
|
|
|
### Full description
|
|
|
|
|
|
Write a description of the bug/request/task here... Be precise and complete.
|
|
|
|
|
|
### Priority
|
|
|
|
|
|
Set the priority we should give to the ticket.
|
|
|
Most of them should be set to "normal".
|
|
|
|
|
|
### Component
|
|
|
### Title
|
|
|
|
|
|
Put the name of the module of Gajim you want to report about here. If you don't know, leave it «None».
|
|
|
A *short* title covering the subject
|
|
|
|
|
|
### Severity
|
|
|
### Description
|
|
|
|
|
|
Here you can estimate the severity of your bug/request.
|
|
|
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.
|
|
|
|
|
|
### Assign to
|
|
|
|
|
|
If you don't know what to put here, leave it blank.
|
|
|
|
|
|
### OS
|
|
|
|
|
|
If you are reporting something which is limited to *only* one OS, select it in the list.
|
|
|
|
|
|
### Milestone
|
|
|
|
|
|
Used to make a release shedule. Please leave it blank for new enhancement requests.
|
|
|
|
|
|
### Version
|
|
|
|
|
|
This is very important for bugs: if we know which version of gajim you use, we can reproduce it easier.
|
|
|
|
|
|
### Keywords
|
|
|
|
|
|
Enter some keywords for your ticket here. You are free to use any keyword you want, but if you post a patch, please add "patch" to keywords.
|
|
|
|
|
|
### CC
|
|
|
|
|
|
You can put your e-mail adress here to stay informed about the evolution of your ticket.
|
|
|
|
|
|
## After that
|
|
|
|
|
|
*Wait and hope* for some dev to comment on that ticket and/or fix your issue. If you do not understand some vocabularies read [that](./GajimDevsSlang). You can also croo your fingers ;-) If you've added your e-mail to *cc*, you will receive an e-mail when your ticket is updated/closed. Off course you can also write a patch yourself (please don't forget to add "patch" to keywords).
|
|
|
|
|
|
== Translations ==
|
|
|
|
|
|
Here is a little how-to in Polish: ![](http://www.gajim.org/imgs/pl_flag.png) [Zgłaszanie błędów po polsku](./ReportingBugsPl)
|
|
|
_Please try to report bugs in English._ |
|
|
\ No newline at end of file |
|
|
Wait and hope for some developer to comment on that issue and/or fix your issue. If you do not understand some vocabularies read [that](./GajimDevsSlang). If you've enabled e-mail notifications, you will receive an e-mail when your issue is updated/closed. Off course you can also write a patch yourself and submit a merge request. |
|
|
\ No newline at end of file |