remove the mailinglist still preferred note, roundup is much nicer even though
[ffmpeg.git] / doc / issue_tracker.txt
1 ffmpegs bug/patch/feature request tracker manual
2 ================================================
3
4 NOTE, this is a draft
5
6 Overview:
7 ---------
8 FFmpeg uses roundup for tracking issues, new issues and changes to
9 existing issues can be done through a web interface and through email.
10 It is possible to subscribe to individual issues by adding yourself to the
11 nosy list or to subscribe to the ffmpeg-issues mailing list which receives
12 a mail for every change to every issue. Replies to such mails will also
13 properly be added to the respective issue.
14 (the above does all work already after light testing)
15 The subscription URL for the ffmpeg-issues list is:
16 http://live.polito.it/mailman/listinfo/ffmpeg-issues
17
18 note: issue = (bug report || patch || feature request)
19
20 Type:
21 -----
22 bug
23     An error, flaw, mistake, failure, or fault in ffmpeg or libav* that
24     prevents it from behaving as intended.
25
26 feature request
27     Request of support for encoding or decoding of a new codec, container
28     or variant.
29     Request of support for more, less or plain different output or behavior
30     where the current behavior cannot be considered wrong.
31
32 patch
33     A patch as generated by diff which conforms to the patch submission and
34     Development Policy.
35
36
37 Priority:
38 ---------
39 critical
40     Bugs and patches which deal with data loss and security issues.
41     No feature request can be critical.
42
43 important
44     Bugs which make ffmpeg unusable for a significant number of users, and
45     patches fixing them.
46     Examples here might be completely broken mpeg4 decoding or a build issue
47     on Linux.
48     While broken 4xm decoding or broken OS/2 build would not be important, the
49     separation to normal is somewhat fuzzy ...
50     For feature requests this priority would be used for things many people
51     want.
52
53 normal
54
55
56 minor
57     Bugs and patches about things like spelling errors, "mp2" instead of
58     "mp3" being shown and such.
59     Feature requests about things few people want or which do not make a big
60     difference.
61
62 wish
63     Something that is desirable to have but that there is no urgency at
64     all to implement, e.g.: something completely cosmetic like a
65     website restyle or a personalized doxy template or the ffmpeg logo.
66     This priority isn't valid for bugs.
67
68
69 Status:
70 -------
71 new
72     initial state
73
74 open
75     intermediate states
76
77 closed
78     Final state
79
80
81 Type/Status/Substatus:
82 ----------
83 */new/new
84     Initial state of new bugs, patches and feature requests submitted by
85     users
86
87 */open/open
88     Issues which have been briefly looked at and which did not look outright
89     invalid.
90     This implicates that no real more detailed state applies yet. And the
91     more detailed states below implicate that the issue has been briefly
92     looked at.
93
94 */closed/duplicate
95     Bugs, patches or feature requests which are duplicate of some other.
96     Note patches dealing with the same thing but differently are not duplicate.
97
98 */closed/invalid
99     Bugs caused by user errors, random ineligible or otherwise nonsense stuff
100
101 bug/open/reproduced
102     Bugs which have been reproduced
103
104 bug/open/analyzed
105     Bugs which have been analyzed and where it is understood what causes them
106     and which exact chain of events triggers them. This analysis should be
107     available as a message in the bugreport.
108     Note, do not change the status to analyzed without also providing a clear
109     and understandable analysis.
110     This state implicates that the bug either has been reproduced or that
111     reproduction is not needed as the bug is understood already anyway.
112
113 bug/open/needs_more_info
114     Bugreports which are incomplete and or where more information is needed
115     from the submitter or another person who can provide the info.
116     This state implicates that the bug has not been analyzed or reproduced.
117
118 bug/closed/fixed
119     Bugs which have to the best of our knowledge been fixed.
120
121 bug/closed/wont_fix
122     Bugs which we will not fix, the reasons here could be legal, philosophical
123     or others.
124
125 bug/closed/works_for_me
126     Bugs for which sufficient information was provided to reproduce but
127     reproduction failed - that is the code seems to work correctly to the
128     best of our knowledge.
129
130 patch/open/approved
131     Patches which have been reviewed and approved by a developer.
132     Such patches can be applied anytime by any other developer after some
133     reasonable testing (compile + regression tests + does the patch do
134     what the author claimed).
135
136 patch/open/needs_changes
137     Patches which have been reviewed and need changes to be accepted.
138
139 patch/closed/applied
140     Patches which have been applied.
141
142 patch/closed/rejected
143     Patches which have been rejected.
144
145 feature_request/open/needs_more_info
146     Feature requests where its not clear what exactly is wanted
147     (these also could be closed as invalid ...).
148
149 feature_request/closed/implemented
150     Feature requests which have been implemented.
151
152 feature_request/closed/wont_implement
153     Feature requests which will not be implemented. The reasons here could
154     be legal, philosophical or others.
155
156 Note, please do not use type-status-substatus combinations other than the
157 above without asking on ffmpeg-dev first!
158
159 Note2, if you provide the requested info dont forget to remove the
160 needs_more_info substate
161
162 Topic:
163 ------
164 A topic is a tag you should add to your issue in order to make grouping them
165 easier. Some tags available: avformat, avcodec, avutils, ffmpeg, roundup