www/project_issues.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
   2 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
   3 <html xmlns="http://www.w3.org/1999/xhtml">
   4 <head>
   5 <style type="text/css"> /* <![CDATA[ */
   6   @import "branding/css/tigris.css";
   7   @import "branding/css/inst.css";
   8   /* ]]> */</style>
   9 <link rel="stylesheet" type="text/css" media="print"
  10   href="branding/css/print.css"/>
  11 <script type="text/javascript" src="branding/scripts/tigris.js"></script>
  12 <title>Subversion Issue Tracker</title>
  13 </head>
  14
  15 <body>
  16 <div class="app">
  17
  18 <div class="h2">
  19 <h2>Subversion Issue Tracker</h2>
  20
  21 <!-- jump to issue form: -->
  22  <table border="0" cellspacing="0" cellpadding="3">
  23   <tr>
  24
  25    <td id="issueid">
  26     <form method="get" action="http://subversion.tigris.org/issues/show_bug.cgi">
  27      <div>
  28       <input name="id" size="6" />
  29       <input type="submit" value="Jump to issue" />
  30      </div>
  31     </form>
  32    </td>
  33   </tr>
  34  </table>
  35
  36 <div class="h3" id="guidelines" title="guidelines">
  37 <h3>Issue Tracker Guidelines</h3>
  38
  39 <div style="color: black; font-size: 130%; font-weight: bold; background-color: #ff5" id="buddy-system" title="buddy-system">
  40
  41 <!-- "line-height: normal" is required to cancel out the line-height
  42   specification in the sitewide stylesheet for "#bodycol" -->
  43 <p style="font-size: 200%; color: red; text-align: center; line-height: normal">
  44 We use the "Buddy System" for filing issues.<br />
  45 Before filing a new issue, please:
  46 </p>
  47
  48 <ul>
  49
  50   <li><p>Re-read the documentation<br />
  51       <span style="font-size: 75%; font-weight: normal">
  52       (especially the <a href="faq.html">FAQ</a> and the
  53       online <a href="http://svnbook.red-bean.com/"
  54       >Subversion book</a>).</span></p></li>
  55
  56   <li><p>Look through <a
  57       href="http://subversion.tigris.org/issues/buglist.cgi?component=subversion&amp;issue_status=UNCONFIRMED&amp;issue_status=NEW&amp;issue_status=STARTED&amp;issue_status=REOPENED"
  58       >all existing issues</a>, or search their summaries:</p>
  59       <form method="get"
  60         action="http://subversion.tigris.org/issues/buglist.cgi"><div>
  61       <input name="short_desc" />
  62       <input type="submit" value="Search!" />
  63       <input type="hidden" name="component" value="subversion" />
  64       <input type="hidden" name="issue_status" value="NEW" />
  65       <input type="hidden" name="issue_status" value="STARTED" />
  66       <input type="hidden" name="issue_status" value="REOPENED" />
  67       <input type="hidden" name="short_desc_type" value="substring" />
  68       <input type="hidden" name="cmdtype" value="doit" />
  69       </div></form>
  70       <p style="font-size: 75%; font-weight: normal">
  71       to see if this bug has already been reported.</p></li>
  72
  73   <li><p>Find someone else who agrees this is a bug.<br />
  74       <span style="font-size: 75%; font-weight: normal">
  75       Post to the <a href="mailto:users@subversion.tigris.org"
  76       >users@subversion.tigris.org</a> mailing list (or to
  77       <a href="mailto:dev@subversion.tigris.org"
  78       >dev@subversion.tigris.org</a> if you're already pretty sure
  79       it's a bug), or chat in <a href="irc://irc.freenode.net/#svn"
  80       >IRC</a>, regarding the bug or feature request you were about to
  81       file.  People there will ask you questions, try to reproduce the
  82       problem, advise you if there's any past history of similar
  83       problems, and in general help you decide whether a new issue is
  84       warranted.  If it is, they can also help you get the bug report
  85       into a useful form.  See <a href="bugs.html">here</a> for how to
  86       write a useful bug report.</span></p>
  87
  88       <p><span style="font-size: 75%; font-weight: normal">If you do
  89       file an issue, <i>remember to include a link to the mailing list
  90       message(s) or IRC conversation where you discussed the problem</i>.
  91       Not only does this provide important context for anyone reading
  92       the issue, it also confirms that the issue has passed the basic
  93       buddy test: you found someone else who agrees it's a problem.
  94       Issues that haven't been through the "buddy system" may be
  95       summarily closed.  We're sorry to do this, but statistically,
  96       most unbuddied filings turn out to be bogus, and the issue
  97       tracker is not a convenient place to separate the good reports
  98       from the bad.</span></p></li>
  99
 100 </ul>
 101
 102 <p>We depend on the mailing list and IRC channel as a first level of
 103 filtering for our bug tracker.  Without this filtering, the tracker
 104 would be full of duplicate issues, non-issues, and unreproducible
 105 issues.  Please help us keep the bug database clean, by always finding
 106 a buddy before you file!</p>
 107
 108 </div>
 109
 110 <p>When mailing the list with a concern, make sure that your e-mail
 111    describes your bug or enhancement fully.  Provide details about the
 112    versions of the relevant software (Subversion, Apache, neon, etc.)
 113    that you are using, about your operating system, and about any
 114    other thing that might seem pertinent to the issue.  If you can
 115    provide a script which consistently reproduces a problem, that can
 116    be incredibly helpful to those evaluating and/or working on your
 117    issue.</p>
 118
 119 </div>
 120
 121 <div class="h3" id="write-access" title="write-access">
 122 <h3>Filing New Issues, Modifying Existing Issues</h3>
 123
 124 <p>You must be <a href="http://subversion.tigris.org/servlets/Login"
 125 >logged in to the web site</a> to add a new issue, or to comment on
 126 existing issues.  To modify existing issues beyond simply leaving a
 127 comment&nbsp;&mdash;&nbsp;e.g., to change fields or
 128 status&nbsp;&mdash;&nbsp;you must be both logged in and have the
 129 <em>Observer</em> role in the Subversion project; this is true even
 130 for issues that you created yourself.</p>
 131
 132 <p>Here's how to acquire the <em>Observer</em> role:</p>
 133
 134 <ol>
 135   <li><a href="http://subversion.tigris.org/servlets/Login"
 136       >Log in</a> on the tigris.org site</li>
 137   <li>Go to the Subversion project front page</li>
 138   <li>Click on the <em>Request project role</em> link directly below the
 139     &quot;Project Home&quot; line</li>
 140   <li>Request the <em>Observer</em> role</li>
 141   <li>Wait for the confirmation e-mail (almost always will be
 142     completed within 24 hours)</li>
 143 </ol>
 144
 145 </div>
 146
 147 <div class="h3" id="fields" title="fields">
 148 <h3>What the Issue Fields Mean</h3>
 149
 150 <p>When an issue is first filed, it automatically goes in the
 151 <b>"---"</b> target milestone, which indicates that the issue has not
 152 yet been processed.  A developer will examine it and maybe talk to
 153 other developers, then estimate the bug's severity, the effort
 154 required to fix it, and schedule it in a numbered milestone, for
 155 example <b>1.1</b>.  (Or they may put it the <b><a
 156 href="http://subversion.tigris.org/issues/buglist.cgi?target_milestone=unscheduled"
 157 >unscheduled</a></b> or <b><a
 158 href="http://subversion.tigris.org/issues/buglist.cgi?target_milestone=nonblocking"
 159 >nonblocking</a></b> milestone, if they consider it tolerable for all
 160 currently planned releases.)  </p>
 161
 162 <p> An issue filed in <b>unscheduled</b> might still get fixed soon,
 163 if some committer decides they want it done.  Putting it in
 164 <b>unscheduled</b> merely means it hasn't been scheduled for any
 165 particular release yet.  The <b>nonblocking</b> milestone, on the
 166 other hand, means that we do not anticipate ever scheduling the issue
 167 for a particular release.  This also does not mean the issue will
 168 never be fixed; it merely means that we don't plan to block any
 169 release on it.</p>
 170
 171 <p>
 172 Severity is represented in the <b>Priority</b> field.  Here is how
 173 priority numbers map to severity:
 174 </p>
 175
 176 <ul>
 177
 178    <li><b>P1:</b> <i>Prevents work from getting done, causes data
 179          loss, or BFI ("Bad First Impression").</i>
 180    </li>
 181
 182    <li><b>P2:</b> <i>Workaround required to get stuff done.</i>
 183    </li>
 184
 185    <li><b>P3:</b> <i>Like P2, but rarely encountered in normal usage.</i>
 186    </li>
 187
 188    <li><b>P4:</b> <i>Developer concern only, API stability or
 189          cleanliness issue.</i>
 190    </li>
 191
 192    <li><b>P5:</b> <i>Nice to fix, but in a pinch we could live with it.</i>
 193    </li>
 194
 195 </ul>
 196
 197 <p>
 198 Effort Required is represented in the <b>Status Whiteboard</b> with an
 199 "<b>e number</b>", which is the average of the most optimistic and
 200 most pessimistic projections for number of engineer/days needed to
 201 fix the bug.  The e number always comes first, so we can sort on the
 202 field, but we include the actual spread after it, so we know when
 203 we're dealing with a wide range.  For example
 204 "<b>e2.5&nbsp;(2&nbsp;/&nbsp;3)</b>" is not quite the same as
 205 "<b>e2.5&nbsp;(1&nbsp;/&nbsp;4)</b>"!</p>
 206
 207 </div>
 208
 209 </div>
 210
 211 <div class="h2" id="enter" title="enter">
 212 <h2>Enter the Issue Tracker</h2>
 213
 214 <p>And so, with further ado, we give you (drumroll&hellip;) the
 215    Subversion <a
 216    href="http://subversion.tigris.org/servlets/ProjectIssues">Issue
 217    Tracker</a>.</p>
 218
 219 <p><i>Again, remember that to add or modify issues, you must be <a
 220 href="#write-access">logged into the website</a>.</i></p>
 221
 222 </div>
 223
 224 </div>
 225 </body>
 226 </html>