Fix the expansion of the $Source$ keyword.
[cvs2svn.git] / www / issue_tracker.html
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
2 "">
3 <html xmlns="">
4 <head>
5 <style type="text/css"> /* <![CDATA[ */
6 @import "tigris-branding/css/tigris.css";
7 @import "tigris-branding/css/inst.css";
8 /* ]]> */</style>
9 <link rel="stylesheet" type="text/css" media="print"
10 href="tigris-branding/css/print.css"/>
11 <script type="text/javascript" src="tigris-branding/scripts/tigris.js"></script>
12 <title>cvs2svn Issue Tracker</title>
13 </head>
15 <body id="bodycol">
16 <div class="app">
18 <!-- jump to issue form: -->
20 <table border="0" cellspacing="0" cellpadding="3">
21 <tr>
22 <td id="issueid">
23 <form method="get" action="">
24 <div>
25 <input name="id" size="6" tabindex="1" />
26 <input value="Jump to issue" tabindex="2" type="submit" />
27 </div>
28 </form>
29 </td>
30 </tr>
31 </table>
33 <h1>cvs2svn Issue Tracker</h1>
35 <h2>Issue Tracker Guidelines</h2>
37 <div class="alert">
38 <p>We welcome bug reports and enhancement requests. However, to make
39 the process of prioritizing cvs2svn tasks easier, we ask that you
40 follow a few guidelines. Before filing an issue in the Issue
41 Tracker, please:</p>
43 <ul>
44 <li>Look through the <a
45 href=""
46 >existing issues</a> to determine if your concern has already
47 been noted by someone else.</li>
48 <li>Make sure that you've read the appropriate documentation (for
49 example, the <a
50 href="">README</a>)
51 to verify that you are using the software appropriately, and to
52 determine if any problems you are seeing are perhaps not real bugs.</li>
53 <li>Send email to the dev list (<a
54 href=""></a>)
55 fully describing the enhancement or bug that brought you here
56 today. That will give the maintainers a chance to ask you
57 questions, confirm that it is a bug, explain the behavior, etc.</li>
58 </ul>
59 </div>
61 <h2>What the Fields Mean</h2>
63 <p>When an issue is first filed, it automatically goes in the
64 <b>"---"</b> milestone, meaning it is unscheduled. A developer will
65 examine it and maybe talk to other developers, then estimate the bug's
66 severity, the effort required to fix it, and schedule it in a numbered
67 milestone, for example <b><a
68 href=""
69 >1.0</a></b>. (Or they may put it the <b><a
70 href=""
71 >future</a></b> or <b><a
72 href=""
73 >no&nbsp;milestone</a></b> milestones, if they consider it tolerable for all currently planned releases.)
74 </p>
76 <p> An issue filed in <b>future</b> might still get fixed soon, if
77 some committer decides they want it done. Putting it in <b>future</b>
78 merely means we're not planning to block any particular release on
79 that issue. </p>
81 <p>
82 Severity is represented in the <b>Priority</b> field. Here is how
83 priority numbers map to severity:
84 </p>
86 <ul>
88 <li><b>P1:</b> <i>Prevents work from getting done, causes data
89 loss, or BFI ("Bad First Impression" -- too embarrassing for
90 a public release).</i>
91 </li>
93 <li><b>P2:</b> <i>Workaround required to get stuff done.</i>
94 </li>
96 <li><b>P3:</b> <i>Like P2, but rarely encountered in normal usage.</i>
97 </li>
99 <li><b>P4:</b> <i>Developer concern only, API stability or
100 cleanliness issue.</i>
101 </li>
103 <li><b>P5:</b> <i>Nice to fix, but in a pinch we could live with it.</i>
104 </li>
106 </ul>
109 Effort Required is sometimes represented in the <b>Status
110 Whiteboard</b> with an "<b>e number</b>", which is the average of the
111 most optimistic and most pessimistic projections for number of
112 engineer/days needed to fix the bug. The e number always comes first,
113 so we can sort on the field, but we include the actual spread after
114 it, so we know when we're dealing with a wide range. For example
115 "<b>e2.5&nbsp;(2&nbsp;/&nbsp;3)</b>" is not quite the same as
116 "<b>e2.5&nbsp;(1&nbsp;/&nbsp;4)</b>"!
117 </p>
119 <h2>Enter the Issue Tracker</h2>
121 <p>And so, with further ado, we give you (drumroll&hellip;) <a
122 href="">the cvs2svn
123 Issue Tracker</a>.</p>
125 </div>
126 </body>
127 </html>