Developers' information regarding the Bug processing system

Initially, a Bug report is submitted by a user as an ordinary mail message to submit@bugs.x2go.org. This will then be given a number, acknowledged to the user, and forwarded to a mailing list (if configured). If the submitter included a Package line listing a package with a known maintainer the maintainer will get a copy too.

The Subject line will have Bug#nnn: added, and the Reply-To will be set to include both the submitter of the report and nnn@bugs.x2go.org.

Closing Bug reports

A developer who receives a Bug from the tracking system, or sees it on the mailing list, and takes responsibility for it should hit Reply in their favourite mailreader, and then edit the To field to say nnn-done@bugs.x2go.org instead of nnn@bugs.x2go.org (nnn-close is provided as an alias for nnn-done).

The address of the original submitter of the Bug report will be included in the default To field, because the Bug system included it in the Reply-To.

Where applicable, please supply a Version line in the pseudo-header of your message when closing a Bug, so that the Bug tracking system knows which releases of the package contain the fix.

`Done' messages are automatically forwarded to the x2go-bugs mailing list, if the mailing list has been set up.

The person closing the Bug and the person who submitted it will each get a notification about the change in status of the report.

Followup messages

If a developer wishes to reply to a Bug report they may simply reply to the message (that will not mark the bug as done). Their reply will (by default, if they respect the Reply-To: header) go to nnn@bugs.x2go.org, and to the original submitter of the Bug report (note: this is two distinct addresses). The Bug tracking system will receive the message at nnn@bugs.x2go.org, pass it on to the package maintainer, file the reply with the rest of the logs for that bug report and forward it to a designated mailing list (x2go-dev@bugs.x2go.org).

A developer may explicitly mail the bug's submitter with an email to nnn-submitter@bugs.x2go.org.

If you wish to send a followup message which is not appropriate for any mailing list you can do so by sending it to nnn-quiet@bugs.x2go.org or nnn-maintonly@bugs.x2go.org. Mail to nnn-quiet@bugs.x2go.org is filed in the Bug Tracking System but is not delivered to any individuals or mailing lists. Mail to nnn-maintonly@bugs.x2go.org is filed in the Bug Tracking System and is delivered only to the maintainer of the package in question.

Do not use the `reply to all recipients' or `followup' feature of your mailer unless you intend to edit down the recipients substantially. In particular, see that you don't send followup messages both to nnn@bugs.x2go.org and to submit@bugs.x2go.org, because the Bug system will then get two copies of it and each one will be forwarded to the designated mailing list separately.

Severity levels

The Bug system records a severity level with each Bug report. This is set to normal by default, but can be overridden either by supplying a Severity line in the pseudo-header when the Bug is submitted (see the instructions for reporting Bugs), or by using the severity command with the control request server. Separate multiple tags with commas, spaces, or both.

The severity levels are:

critical

makes unrelated software on the system (or the whole system) break, or causes serious data loss, or introduces a security hole on systems where you install the package.

grave

makes the package in question unusable or mostly so, or causes data loss, or introduces a security hole allowing access to the accounts of users who use the package.

normal

the default value, for normal Bugs.

wishlist

for any feature request, and also for any Bugs that are very difficult to fix due to major design considerations.

Tags for Bug reports

Each Bug can have zero or more of a set of given tags. These tags are displayed in the list of Bugs when you look at a package's page, and when you look at the full Bug log.

Tags can be set by supplying a Tags line in the pseudo-header when the Bug is submitted (see the instructions for reporting Bugs), or by using the tags command with the control request server.

The current Bug tags are:

patch

A patch or some other easy procedure for fixing the Bug is included in the Bug logs. If there's a patch, but it doesn't resolve the Bug adequately or causes some other problems, this tag should not be used.

wontfix

This Bug won't be fixed. Possibly because this is a choice between two arbitrary ways of doing things and the maintainer and submitter prefer different ways of doing things, possibly because changing the behaviour will cause other, worse, problems for others, or possibly for other reasons.

moreinfo

This Bug can't be addressed until more information is provided by the submitter. The Bug will be closed if the submitter doesn't provide more information in a reasonable (few months) timeframe. This is for Bugs like "It doesn't work". What doesn't work?

unreproducible

This Bug can't be reproduced on the maintainer's system. Assistance from third parties is needed in diagnosing the cause of the problem.

fixed

This Bug is fixed or worked around, but there's still an issue that needs to be resolved.

stable

This Bug affects the stable distribution in particular. This is only intended to be used for ease in identifying release critical Bugs that affect the stable distribution. It'll be replaced eventually with something a little more flexible, probably.

Recording that you have passed on a Bug report

When a developer forwards a Bug report to the developer of the upstream source package from which the X2Go package is derived, they should note this in the Bug tracking system as follows:

Make sure that the To field of your message to the author has only the author(s) address(es) in it; put both the person who reported the Bug, nnn-forwarded@bugs.x2go.org and nnn@bugs.x2go.org in the CC field.

Ask the author to preserve the CC to nnn-forwarded@bugs.x2go.org and nnn@bugs.x2go.org when they reply, so that the Bug tracking system will file their reply with the original report. These messages are only filed and are not sent on; to send a message as normal, send them to nnn@bugs.x2go.org as well.

When the Bug tracking system gets a message at nnn-forwarded it will mark the relevant Bug as having been forwarded to the address(es) in the To field of the message it gets, if the Bug is not already marked as forwarded.

You can also manipulate the `forwarded to' information by sending messages to control@bugs.x2go.org.

Changing Bug ownership

In cases where the person responsible for fixing a Bug is not the assigned maintainer for the associated package (for example, when the package is maintained by a team), it may be useful to record this fact in the Bug tracking system. To help with this, each Bug may optionally have an owner.

The owner can be set by supplying an Owner line in the pseudo-header when the Bug is submitted (see the instructions for reporting Bugs), or by using the owner and noowner commands with the control request server.

Summary postings

Every Friday, a list of outstanding Bug reports is posted to a summary mailing list (if set up), sorted by age of report. Every Tuesday, a list of Bug reports that have gone unanswered too long is posted, sorted by package maintainer.

Reopening, reassigning and manipulating Bugs

It is possible to reassign Bug reports to other packages, to reopen erroneously-closed ones, to modify the information saying to where, if anywhere, a Bug report has been forwarded, to change the severities and titles of reports, to set the ownership of Bugs, to merge and unmerge Bug reports, and to record the versions of packages in which Bugs were found and in which they were fixed. This is done by sending mail to control@bugs.x2go.org.

The format of these messages is described in another document available on the World Wide Web or in the file bug-maint-mailcontrol.txt. A plain text version can also be obtained by mailing the word help to the server at the address above.

More-or-less obsolete subject-scanning feature

Messages that arrive at submit or Bugs whose Subject starts Bug#nnn will be treated as having been sent to nnn@bugs.x2go.org. This is both for backwards compatibility with mail forwarded from the old addresses, and to catch followup mail sent to submit by mistake (for example, by using reply to all recipients).

A similar scheme operates for maintonly, done, quiet and forwarded, which treat mail arriving with a Subject tag as having been sent to the corresponding nnn-whatever@bugs.x2go.org address.

Messages arriving at plain forwarded and done - ie, with no Bug report number in the address - and without a Bug number in the Subject will be filed under `junk' and kept for a few weeks, but otherwise ignored.

Other pages:

• Bug tracking system main contents page.
• Instructions for reporting Bugs.
• Accessing the Bug tracking logs other than by WWW.
• Mailservers' reference card.
• Full list of outstanding and recent Bug reports.
• Packages with Bug reports.
• Maintainers of packages with Bug reports.