Miscellaneous doc fixes.
[cvs2svn.git] / www / issue_tracker.html
blob9165314806b23a7036281546e691ad35f42f37b0
2 <!-- jump to issue form: -->
3 <table border="0" cellspacing="0" cellpadding="3">
4 <tr>
6 <td id="issueid">
7 <form method="get" action="http://cvs2svn.tigris.org/issues/show_bug.cgi" tabindex="1">
8 <input name="id" size="6" tabindex="2" />
9 <input type="submit" value="Jump to issue" tabindex="3" />
10 </form>
11 </td>
12 </tr>
13 </table>
17 <h1>cvs2svn Issue Tracker</h1>
19 <h2>Issue Tracker Guidelines</h2>
21 <div class="alert">
22 <p>We welcome bug reports and enhancement requests. However, to make
23 the process of prioritizing cvs2svn tasks easier, we ask that you
24 follow a few guidelines. Before filing an issue in the Issue
25 Tracker, please:</p>
27 <ul>
28 <li>Look through the <a
29 href="http://cvs2svn.tigris.org/issues/buglist.cgi?component=cvs2svn"
30 >existing issues</a> to determine if your concern has already
31 been noted by someone else.</li>
32 <li>Make sure that you've read the appropriate documentation (for
33 example, the <a
34 href="http://svn.collab.net/repos/cvs2svn/trunk/README">README</a>)
35 to verify that you are using the software appropriately, and to
36 determine if any problems you are seeing are perhaps not real bugs.</li>
37 <li>Send email to the dev list (<a
38 href="mailto:dev@cvs2svn.tigris.org">dev@cvs2svn.tigris.org</a>)
39 fully describing the enhancement or bug that brought you here
40 today. That will give the maintainers a chance to ask you
41 questions, confirm that it is a bug, explain the behavior, etc.</li>
42 </ul>
43 </div>
45 <h2>What the Fields Mean</h2>
47 <p>When an issue is first filed, it automatically goes in the
48 <b>"---"</b> milestone, meaning it is unscheduled. A developer will
49 examine it and maybe talk to other developers, then estimate the bug's
50 severity, the effort required to fix it, and schedule it in a numbered
51 milestone, for example <b><a
52 href="http://cvs2svn.tigris.org/issues/buglist.cgi?target_milestone=1.0"
53 >1.0</a></b>. (Or they may put it the <b><a
54 href="http://cvs2svn.tigris.org/issues/buglist.cgi?target_milestone=future"
55 >future</a></b> or <b><a
56 href="http://cvs2svn.tigris.org/issues/buglist.cgi?target_milestone=no%20milestone"
57 >no&nbsp;milestone</a></b> milestones, if they consider it tolerable for all currently planned releases.)
58 </p>
60 <p> An issue filed in <b>future</b> might still get fixed soon, if
61 some committer decides they want it done. Putting it in <b>future</b>
62 merely means we're not planning to block any particular release on
63 that issue. </p>
65 <p>
66 Severity is represented in the <b>Priority</b> field. Here is how
67 priority numbers map to severity:
68 </p>
70 <p>
71 <ul>
73 <li><b>P1:</b> <i>Prevents work from getting done, causes data
74 loss, or BFI ("Bad First Impression" -- too embarrassing for
75 a public release).</i>
76 </li>
78 <li><b>P2:</b> <i>Workaround required to get stuff done.</i>
79 </li>
81 <li><b>P3:</b> <i>Like P2, but rarely encountered in normal usage.</i>
82 </li>
84 <li><b>P4:</b> <i>Developer concern only, API stability or
85 cleanliness issue.</i>
86 </li>
88 <li><b>P5:</b> <i>Nice to fix, but in a pinch we could live with it.</i>
89 </li>
91 </ul>
92 </p>
94 <p>
95 Effort Required is sometimes represented in the <b>Status
96 Whiteboard</b> with an "<b>e number</b>", which is the average of the
97 most optimistic and most pessimistic projections for number of
98 engineer/days needed to fix the bug. The e number always comes first,
99 so we can sort on the field, but we include the actual spread after
100 it, so we know when we're dealing with a wide range. For example
101 "<b>e2.5&nbsp;(2&nbsp;/&nbsp;3)</b>" is not quite the same as
102 "<b>e2.5&nbsp;(1&nbsp;/&nbsp;4)</b>"!
104 <h2>Enter the Issue Tracker</h2>
106 <p>And so, with further ado, we give you (drumroll&hellip;) <a
107 href="http://cvs2svn.tigris.org/servlets/ProjectIssues">the cvs2svn
108 Issue Tracker</a>.</p>