html/Developer.html.in

   1 $gDeveloperHtml = <<HTML_END
   2 <HTML>
   3 <HEAD>
   4         <title>$gProject - Developers' information</title>
   5         <link rev="made" href="mailto:$gMaintainerEmail">
   6 </head>
   7 <body>
   8         <h1><A name="developers">Developers' information regarding the $gBug processing system</A></h1>
   9
  10 Initially, a $gBug report is submitted by a user as an ordinary mail
  11 message to <code>submit\@$gEmailDomain</code>.  This will then be
  12 given a number, acknowledged to the user, and forwarded to a mailing
  13 list (if configured).  If the submitter included a <code>Package</code>
  14 line listing a package with a known maintainer the maintainer will get
  15 a copy too.
  16 <p>
  17
  18 The <code>Subject</code> line will have
  19 <code>$gBug#</code><var>nnn</var><code>:</code> added, and the
  20 <code>Reply-To</code> will be set to include both the submitter of the
  21 report and <var>nnn</var><code>\@$gEmailDomain</code>.
  22 <p>
  23
  24 <h2>Closing $gBug reports</h2>
  25
  26 A developer who receives a $gBug from the tracking system, or sees it on
  27 the mailing list, and takes responsibility for it should hit Reply in
  28 their favourite mailreader,
  29 and then edit the <code>To</code> field to say
  30 <var>nnn</var><code>-done\@$gEmailDomain</code> instead of
  31 <var>nnn</var><code>\@$gEmailDomain</code>
  32 (<var>nnn</var><code>-close</code> is provided as an alias for
  33 <var>nnn</var><code>-done</code>).
  34 <p>
  35
  36 The address of the original submitter of the $gBug report will be
  37 included in the default <code>To</code> field, because the $gBug system
  38 included it in the <code>Reply-To</code>.
  39 <p>
  40
  41 `Done' messages are forwarded to a mailing list if the mailing list has been
  42 set up.
  43 <P>
  44
  45 The person closing the $gBug and the person who submitted it will each
  46 get a notification about the change in status of the report.
  47
  48 <h2>Followup messages</h2>
  49
  50 If a developer wishes to reply to a $gBug report without marking the $gBug
  51 as done they may simply reply to the message.  Their reply will (by
  52 default) go to <var>nnn</var><code>\@$gEmailDomain</code> and to the original
  53 submitter of the $gBug report.  The $gBug tracking system will file the
  54 reply with the rest of the logs for that $gBug report and forward it to
  55 a designated mailing list.  The $gBug will not be marked as done.
  56 <p>
  57
  58 If you wish to send a followup message which is not appropriate for
  59 any mailing list you can do so by sending it to
  60 <var>nnn</var><code>-quiet\@$gEmailDomain</code> or
  61 <var>nnn</var><code>-maintonly\@$gEmailDomain</code>, which only file it (not
  62 forwarding it anywhere) and send it on only to the maintainer of the
  63 package in question, respectively.
  64 <p>
  65
  66 Do <em>not</em> use the `reply to all recipients' or `followup'
  67 feature of your mailer unless you intend to edit down the recipients
  68 substantially.  In particular, don't send a followup message both to
  69 <var>nnn</var><code>\@$gEmailDomain</code> and to
  70 <code>submit\@$gEmailDomain</code>, because the $gBug system will then
  71 get two copies of it and each one will be forwarded to the designated
  72 mailing list separately.
  73 <p>
  74
  75 <h2><A name="severities">Severity levels</A></h2>
  76
  77 The $gBug system records a severity level with each $gBug report.  This is
  78 set to <code>$gDefaultSeverity</code> by default, but can be overridden either by
  79 supplying a <code>Severity</code> line in the psuedo-header when the
  80 $gBug is submitted (see the
  81 <A href="Reporting.html#psuedoheader">instructions for reporting
  82 $gBugs</A>), or by using the <code>severity</code> command with the
  83 <A href="#requestserv">control request server</A>.
  84
  85 <p>
  86
  87 The severity levels are:
  88
  89 <dl>
  90 $gHTMLSeverityDesc
  91 </dl>
  92
  93 <h2><A name="forward">Recording that you have passed on a $gBug report</A></h2>
  94
  95 When a developer forwards a $gBug report to the developer of the
  96 upstream source package from which the $gProject package is derived,
  97 they should note this in the $gBug tracking system as follows:
  98 <p>
  99
 100 Make sure that the <code>To</code> field of your message to the author
 101 to has only the author(s) address(es) in it; put both the person who
 102 reported the $gBug and
 103 <var>nnn</var><code>-forwarded\@$gEmailDomain</code> in the
 104 <code>CC</code> field.
 105 <p>
 106
 107 Ask the author to preserve the <code>CC</code> to
 108 <var>nnn</var><code>-forwarded\@$gEmailDomain</code> when they reply, so that
 109 the $gBug tracking system will file their reply with the original
 110 report.
 111 <p>
 112
 113 When the $gBug tracking system gets a message at
 114 <var>nnn</var><code>-forwarded</code> it will mark the relevant $gBug as
 115 having been forwarded to the address(es) in the <code>To</code> field
 116 of the message it gets.
 117 <p>
 118
 119 You can also manipulate the `forwarded to' information by sending messages to
 120 <A href="server-control.html"><code>control\@$gEmailDomain</code></A>.
 121
 122 <h2>Summary postings</h2>
 123
 124 Every Friday, a list of outstanding $gBug reports is posted to a summary mailing
 125 list (if set up), sorted by age of report.
 126 Every Tuesday, a list of $gBug reports that have gone unanswered too long is
 127 posted, sorted by package maintainer.
 128 <p>
 129
 130 $gBadMaintHtml
 131
 132 <h2><A name="requestserv">Reopening, reassigning and manipulating $gBugs</A></h2>
 133
 134 It is possible to reassign $gBug reports to other packages, to reopen
 135 erroneously-closed ones, to modify the information saying to where, if
 136 anywhere, a $gBug report has been forwarded, to change the severities
 137 and titles of reports and to merge and unmerge $gBug reports.  This is
 138 done by sending mail to <code>control\@$gEmailDomain</code>.
 139 <p>
 140
 141 The <A href="server-control.html">format of these messages</A> is
 142 described in another document available on the World Wide Web or in
 143 the file <code>bug-maint-mailcontrol.txt</code>.  A plain text version
 144 can also be obtained by mailing the word <code>help</code> to the
 145 server at the address above.
 146
 147 <h2>More-or-less obsolete subject-scanning feature</h2>
 148 (this is likely to be removed the next version)<BR>
 149 Messages that arrive at <code>submit</code> or <code>$gBugs</code> whose
 150 Subject starts <code>Bug#</code><var>nnn</var> will be treated as
 151 having been sent to <var>nnn</var><code>\@$gEmailDomain</code>.  This is both
 152 for backwards compatibility with mail forwarded from the old
 153 addresses, and to catch followup mail sent to <code>submit</code> by
 154 mistake (for example, by using reply to all recipients).
 155
 156 <p>
 157
 158 A similar scheme operates for <code>maintonly</code>,
 159 <code>done</code>, <code>quiet</code> and <code>forwarded</code>,
 160 which treat mail arriving with a Subject tag as having been sent to
 161 the corresponding <var>nnn-whatever</var><code>\@$gEmailDomain</code> address.
 162
 163 <p>
 164
 165 Messages arriving at plain <code>forwarded</code> and
 166 <code>done</code> - ie, with no $gBug report number in the address - and
 167 without a $gBug number in the Subject will be filed under `junk' and
 168 kept for a few weeks, but otherwise ignored.
 169
 170 <h2><A name="future">Future plans</A></h2>
 171
 172 At some point the <code>Package:</code> secondary header field may
 173 become mandatory - at the moment omitting it just produces a warning
 174 message.
 175
 176 <hr>
 177 Other pages:
 178 <ul>
 179 <li><A href="./">$gBug tracking system main contents page.</A>
 180 <li><A href="Reporting.html">Instructions for reporting $gBugs.</A>
 181 <li><A href="Access.html">Accessing the $gBug tracking logs other than by WWW.</A>
 182 <li><A href="server-refcard.html">Mailservers' reference card.</A>
 183 <li><A href="db/ix/full.html">Full list of outstanding and recent $gBug reports.</A>
 184 <li><A href="db/ix/packages.html">Packages with $gBug reports.</A>
 185 <li><A href="db/ix/maintainers.html">Maintainers of packages with $gBug reports.</A>
 186
 187 $gHTMLOtherPageList
 188
 189 </ul>
 190
 191 $gHTMLTail
 192
 193 HTML_END