Add some more documentation : how to add a new target to OpenWrt, howto report bugs...
[openwrt/staging/dedeckeh.git] / docs / bugs.tex
1 OpenWrt as an open source software opens its developpment to the community by having a publicly browseable subversion repository. The Trac software which comes along with a Subversion frontend, a Wiki and a ticket reporting system is used as an interface between developpers, users and contributors in order to make the whole developpment process much easier and efficient.
2
3 We make distinction between two kinds of people within the Trac system :
4
5 \begin{itemize}
6 \item developpers, able to report, close and fix tickets
7 \item reporters, able to add a comment, patch, or request ticket status
8 \end{itemize}
9
10 \subsubsection{Opening a ticket}
11
12 A reporter might want to open a ticket for the following reasons :
13
14 \begin{itemize}
15 \item a bug affects a specific hardware and/or software and needs to be fixed
16 \item a specific software package would be seen as part of the official OpenWrt repository
17 \item a feature should be added or removed from OpenWrt
18 \end{itemize}
19
20 Regarding the kind of ticket that is open, a patch is welcome in those cases :
21
22 \begin{itemize}
23 \item new package to be included in OpenWrt
24 \item fix for a bug that works for the reporter and has no known side effect
25 \item new features that can be added by modifying existing OpenWrt files
26 \end{itemize}
27
28 In order to include a patch, you need to produce it, this can be done by using the \textbf{svn diff} command which generates the differences between your local copy (modified) and the version on the OpenWrt repository (unmodified yet). Then attach the patch with a description, using the "Attach" button.
29
30 Once the ticket is open, a developper will take care of it, if so, the ticket is marked as "accepted" with the developper name. You can add comments at any time to the ticket, even when it is closed.
31
32 \subsubsection{Closing a ticket}
33
34 A ticket might be closed by a developper because :
35
36 \begin{itemize}
37 \item the problem is already fixed (wontfix)
38 \item the problem described is not judged as valid, and comes along with an explanation why (invalid)
39 \item the developpers know that this bug will be fixed upstream (wontfix)
40 \item the problem is very similar to something that has already been reported (duplicate)
41 \item the problem cannot be reproduced by the developpers (worksforme)
42 \end{itemize}
43
44 A the same time, the reporter may want to get the ticket closed since he is not longer able to trigger the bug, or found it invalid by himself.
45
46 When a ticket is closed by a developper and marked as "fixed", the comment contains the subversion changeset which corrects the bug.