Diff for "Bugs/Subscriptions"

Not logged in - Log In / Register

Differences between revisions 1 and 9 (spanning 8 versions)
Revision 1 as of 2008-03-19 17:51:41
Size: 4977
Comment:
Revision 9 as of 2008-05-19 14:29:35
Size: 6888
Comment: added unsubscribe anchor
Deletions are marked like this. Additions are marked like this.
Line 19: Line 19:
  * project or package [:Bugs/BugContactRole:bug contact].   * project or package bug supervisor.
Line 25: Line 26:
If you're the bug contact for a package or project you'll automatically receive email about updates to any bugs relating to that package or project. If you're the bug supervisor for a package or project you'll automatically receive email about updates to any bugs relating to that package or project.
Line 27: Line 28:
To receive notifications about a milestone in a project, a distribution (e.g. Ubuntu) or a package or project for which you're not a bug contact, click ```Subscribe to bugmail``` in the ```Actions``` menu on the milestone, project, package or distribution bugs overview page. To receive notifications about a milestone in a project, a distribution (e.g. Ubuntu) or a package or project for which you're not a bug supervisor, click ```Subscribe to bugmail``` in the ```Actions``` menu on the milestone, project, package or distribution bugs overview page.
Line 42: Line 43:
Here's an example of the headers Launchpad added to an email about a bug reported against Exaile: == Bug mail headers ==
Line 44: Line 45:
{{{X-Launchpad-Bug: product=exaile; status=Confirmed;
 importance=Low; assignee=None;
X-Launchpad-Bug-Private: no
X-Launchpad-Bug-Security-Vulnerability: no
X-Launchpad-Message-Rationale: Subscriber (Exaile)
 @exaile
}}}
Launchpad uses email headers to help you automatically filter bug mail.
Line 52: Line 47:
They're fairly self-explanatory but the content of ```X-Launchpad-Bug``` differs depending on whether the email is about a distribution package or an upstream project.  * '''X-Launchpad-Bug:''' see ''[:Bugs/Subscriptions#x-launchpad-bug:X-Launchpad-Bug]'' section below.
 * '''X-Launchpad-Bug-Private:''' ```yes``` or ```no```
 * '''X-Launchpad-Bug-Security-Vulnerability:''' ```yes``` or ```no```
 * '''X-Launchpad-Message-Rationale:''' see ''[:Bugs/Subscriptions#rationale:Bug mail rationale]'' section below.



[[Anchor(x-launchpad-bug)]]
=== X-Launchpad-Bug ===

The ```X-Launchpad-Bug``` header collates most of the other information about a bug's status, importance, etc. It gives you slightly different information, depending on whether you're dealing with a distribution package or a project:
Line 56: Line 61:
 * ```product```: the project's Launchpad name  * ```product```
Line 60: Line 65:
  '''Distribution package:'''  * '''For example:''' ```X-Launchpad-Bug: product=terminator; status=Confirmed; importance=Low; assignee=None;```

'''Package:'''
Line 69: Line 75:
 * '''For example:''' ```X-Launchpad-Bug: distribution=ubuntu; sourcepackage=exaile; component=universe; status=Confirmed; importance=Medium; assignee=None;```
Line 70: Line 77:

[[Anchor(rationale)]]
=== Bug mail rationale ===

The ```X-Launchpad-Message-Rationale``` header tells you why you've received the notification.

You can be either:

 * ```Assignee```
 * ```Subscriber```
 * ```Bug Supervisor```
 * ```Registrant```.
 
For example: ```X-Launchpad-Message-Rationale: Assignee```

An ```@``` symbol shows that you're related to the bug through membership of a team:

{{{
    X-Launchpad-Message-Rationale: Assignee @ubuntu-kernel-bugs
    X-Launchpad-Message-Rationale: Subscriber @ubuntu-core-dev
}}}

If you're the project/package owner or bug supervisor, the product/package name is show in parentheses:

{{{
    X-Launchpad-Message-Rationale: Bug Supervisor (mozilla-firefox in ubuntu)
    X-Launchpad-Message-Rationale: Registrant (kiwi)
}}}

The ```@``` symbol and team name are combined when you are a member of a team that is a bug supervisor:

{{{
    X-Launchpad-Message-Rationale: Bug Supervisor (ubuntu) @ubuntu-bugs
}}}

If the notification is about a duplicate bug, the rationale shows you which bug this report duplicates:

{{{
    X-Launchpad-Message-Rationale: Assignee via Bug 1332
}}}

This makes it easy to filter out bug mail about duplicate bugs. For example: let's say this bug notification is for bug 2129. This header means you are the assignee of bug 1332, of which 2129 is a duplicate.

([[Anchor(unsubscribe)]])
Line 72: Line 123:
You can unsubscribe from bug notifications at any time. If you've subscribed You can unsubscribe from bug notifications at any time.
Line 74: Line 125:
'''Individual bugs:''' visit the bug report and click ```Unsubscribe``` in the ```Actions``` menu.
'''All bugs in a particular context:''' visit the context's overview page - such as a project's overview page - and select ```Subscribe to bug mail```. Follow this if you're a bug supervisor but no longer want to receive the associated bug notifications.

{i} '''Note:''' if you receive bug mail because you're in a team that is a bug supervisor, reporter, commenter or assignee, you must leave that team to stop receiving the notifications.
Line 77: Line 132:
||<tablestyle="float:right; font-size: 0.8em; width:30%; background:#F1F1ED; margin: 0 0 1em 1em;" style="padding:0.5em;">attachment:google-reader-bugs-feed3.png||
||<style="text-align: center;">'''A bugs feed in Google Reader'''||
Line 78: Line 135:
Use the first two paragraphs to summarise all the important points about this article. You can subscribe to a feed of the bugs that affect a person, team, project or distribution. You can also subscribe to individual bugs.
Line 80: Line 137:
Tell the reader if this is the information they need as soon as possible. Most feed readers will automatically discover the bug feed if you give them the URL of the bug report or the person, team, project or distribution overview page.
Line 82: Line 139:
= Instructional text = Alternatively, you can build the bug feed URL by hand:
Line 84: Line 141:
Where appropriate, use step by step instructions: '''Individual bugs:''' ```http://feeds.launchpad.net/bugs/<number>/bug.atom```
Line 86: Line 143:
'''Step 1:''' Give concise and unambiguous instructions. Replace ```<number>``` with the bug number.
Line 88: Line 145:
'''Step 2:''' Try not to state the obvious, unless you're writing for a novice user. For example: http://feeds.launchpad.net/bugs/1/bug.atom
Line 90: Line 147:
{i} '''Note:''' Highlight important information with a note. '''Projects and distributions:''' ```http://feeds.launchpad.net/<project or distro name>/latest-bugs.atom```
Line 92: Line 149:
'''Step 3:''' Use a well cropped screen shot if it will help orient the reader. Don't let the screen shot replace instructional text: not everyone can see your screen shot. Don't worry about borders or annotation for small, cropped screen shots such as this. Replace ```<project or distro name>``` accordingly.
Line 94: Line 151:
attachment:screen-shot.png For example: http://feeds.launchpad.net/ubuntu/latest-bugs.atom
Line 96: Line 153:
{i} '''Warning:''' If you're about to tell the reader to delete or otherwise change something that would be hard to restore, warn them. '''People and teams:''' ```http://feeds.launchpad.net/~<person or team name>/latest-bugs.atom```
Line 98: Line 155:
Replace ```<person or team name>``` accordingly.
Line 99: Line 157:
== Full screen shots == For example: http://feeds.launchpad.net/~bzr/latest-bugs.atom
Line 101: Line 159:
||<tablestyle="float:right; font-size: 0.8em; width:30%; background:#F1F1ED; margin: 0 0 1em 1em;" style="padding:0.5em;">attachment:proj-announce.png||
||<style="text-align: center;">'''Describe the screen shot here'''||
= Next steps =
Line 104: Line 161:
Some screen shots will be better placed to the right of your text. As they're not placed directly below the text that they support, use a border and short description.

Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aliquam sagittis. Aliquam eros dui, scelerisque id, consequat in, accumsan vitae, pede. Suspendisse neque ligula, scelerisque ac, mattis ut, aliquam quis, odio.

Proin nunc nisi, fringilla ac, congue ac, luctus eu, lacus. Maecenas ac purus. Cras felis metus, ultricies non, euismod ac, accumsan eleifend, leo. Quisque imperdiet tempus tellus.

Ut euismod, diam nec adipiscing interdum, tortor orci fringilla nisi, vel blandit erat magna at nisi. Fusce hendrerit odio non metus. Mauris nisl massa, dapibus id, feugiat quis, blandit a, quam. Integer tincidunt feugiat nunc. Curabitur iaculis egestas elit. Nam imperdiet suscipit odio.
Once you've reported and commented on a few bugs, you might want to get more involved in the day to day management of a project's bugs. The role of [:Bugs/BugContactRole:bug supervisor] is one of the most important to a project that uses Launchpad's bug tracker.

DRAFT: this page is a work in progress. Please [:Feedback:seek further help] or check the [:TitleIndex:wiki index] for a complete page on this topic.

ContentsBRTableOfContents

Overview

Launchpad uses notification emails and Atom feeds to help you stay on top of the bugs that interest you.

Bug mail

There are three ways to get bug notifications by email:

  • subscribe to a bug
  • subscribe to a milestone, project, package or distribution
  • take a role that results in bug mail:
    • bug reporter
    • assignee
    • commenter
    • project or package bug supervisor.

Subscribing to an individual bug is as simple clicking Subscribe on the bug report page. You can also subscribe another individual or a team to a bug. However, you should only do this if you're certain the person or team members are happy for you to do so.

Subscribing to an entire milestone, project, package or distribution

If you're the bug supervisor for a package or project you'll automatically receive email about updates to any bugs relating to that package or project.

To receive notifications about a milestone in a project, a distribution (e.g. Ubuntu) or a package or project for which you're not a bug supervisor, click Subscribe to bugmail in the Actions menu on the milestone, project, package or distribution bugs overview page.

What you'll receive

Launchpad sends bug notifications when:

  • a new bug is reported
  • someone makes a comment on a bug
  • a bug's status or importance changes
  • a bug is assigned to someone
  • a bug is targeted to a milestone
  • a bug is marked as affecting a new series, package or project.

You can filter bug mail based on both the subject and headers. A prefix of [NEW] in the subject lets you distinguish emails about newly reported bugs from updates about previous bugs.

Bug mail headers

Launchpad uses email headers to help you automatically filter bug mail.

  • X-Launchpad-Bug: see [:Bugs/Subscriptions#x-launchpad-bug:X-Launchpad-Bug] section below.

  • X-Launchpad-Bug-Private: yes or no

  • X-Launchpad-Bug-Security-Vulnerability: yes or no

  • X-Launchpad-Message-Rationale: see [:Bugs/Subscriptions#rationale:Bug mail rationale] section below.

Anchor(x-launchpad-bug)

X-Launchpad-Bug

The X-Launchpad-Bug header collates most of the other information about a bug's status, importance, etc. It gives you slightly different information, depending on whether you're dealing with a distribution package or a project:

Project:

  • product

  • status

  • importance

  • assignee

  • For example: X-Launchpad-Bug: product=terminator; status=Confirmed; importance=Low; assignee=None;

Package:

  • distribution

  • sourcepackage

  • component

  • status

  • importance

  • assignee

  • For example: X-Launchpad-Bug: distribution=ubuntu; sourcepackage=exaile; component=universe; status=Confirmed; importance=Medium; assignee=None;

Anchor(rationale)

Bug mail rationale

The X-Launchpad-Message-Rationale header tells you why you've received the notification.

You can be either:

  • Assignee

  • Subscriber

  • Bug Supervisor

  • Registrant.

For example: X-Launchpad-Message-Rationale: Assignee

An @ symbol shows that you're related to the bug through membership of a team:

    X-Launchpad-Message-Rationale: Assignee @ubuntu-kernel-bugs
    X-Launchpad-Message-Rationale: Subscriber @ubuntu-core-dev

If you're the project/package owner or bug supervisor, the product/package name is show in parentheses:

    X-Launchpad-Message-Rationale: Bug Supervisor (mozilla-firefox in ubuntu)
    X-Launchpad-Message-Rationale: Registrant (kiwi)

The @ symbol and team name are combined when you are a member of a team that is a bug supervisor:

    X-Launchpad-Message-Rationale: Bug Supervisor (ubuntu) @ubuntu-bugs

If the notification is about a duplicate bug, the rationale shows you which bug this report duplicates:

    X-Launchpad-Message-Rationale: Assignee via Bug 1332

This makes it easy to filter out bug mail about duplicate bugs. For example: let's say this bug notification is for bug 2129. This header means you are the assignee of bug 1332, of which 2129 is a duplicate.

(Anchor(unsubscribe))

Unsubscribing

You can unsubscribe from bug notifications at any time.

Individual bugs: visit the bug report and click Unsubscribe in the Actions menu. All bugs in a particular context: visit the context's overview page - such as a project's overview page - and select Subscribe to bug mail. Follow this if you're a bug supervisor but no longer want to receive the associated bug notifications.

{i} Note: if you receive bug mail because you're in a team that is a bug supervisor, reporter, commenter or assignee, you must leave that team to stop receiving the notifications.

Atom feeds

attachment:google-reader-bugs-feed3.png

A bugs feed in Google Reader

You can subscribe to a feed of the bugs that affect a person, team, project or distribution. You can also subscribe to individual bugs.

Most feed readers will automatically discover the bug feed if you give them the URL of the bug report or the person, team, project or distribution overview page.

Alternatively, you can build the bug feed URL by hand:

Individual bugs: http://feeds.launchpad.net/bugs/<number>/bug.atom

Replace <number> with the bug number.

For example: http://feeds.launchpad.net/bugs/1/bug.atom

Projects and distributions: http://feeds.launchpad.net/<project or distro name>/latest-bugs.atom

Replace <project or distro name> accordingly.

For example: http://feeds.launchpad.net/ubuntu/latest-bugs.atom

People and teams: http://feeds.launchpad.net/~<person or team name>/latest-bugs.atom

Replace <person or team name> accordingly.

For example: http://feeds.launchpad.net/~bzr/latest-bugs.atom

Next steps

Once you've reported and commented on a few bugs, you might want to get more involved in the day to day management of a project's bugs. The role of [:Bugs/BugContactRole:bug supervisor] is one of the most important to a project that uses Launchpad's bug tracker.

Bugs/Subscriptions (last edited 2021-01-19 02:15:58 by logan)