Latest revision as of 11:30, 14 August 2012

[edit] How to organize a BugDay

 

Note
This is a WIP page on how we organize our BugDays. Information is collected and refined here, so more people can take part in planning and conducting such events. When it's done we should have a good checklist as well as some checkpoints (including when to do what).

[edit] Choosing a target

First of all you need to pick a good target for the BugDay including whether to triage or krush. Generally you should keep the following in mind:

• Make sure you contact the developers of the product you're working on early enough to get their support (2-3 weeks in advance).
• Choose an application that's important enough for users so some of them join the effort.

[edit] Triage

Parts of KDE that qualify are usually applications with a bug count so high its developers have trouble keeping up. The weekly summary statistic page on our bug tracker can serve as a starting point.

[edit] Krush

Krush days are usually suitable for finding plenty of bugs in advance of a release. It's also easier for inexperienced people to take part if beta versions are available via regular distribution channels.

(Could be done at the beginning of the beta phase, with the new features in green published by the developers at, by example, http://techbase.kde.org/Schedules/KDE4/4.6_Feature_Plan)

[edit] Organizing

Organizing a BugDay should be a joint effort which is coordinated using the BugSquad mailinglist (bugsquad@kde.org). If you want as many people as possible to help, make sure you post to the mailinglist in time.

• Often developers will have special requests (like intervals of bugs or specific components to triage). Take that into account.
• Let the developers tell you which version of their software people should use when working on bugs.

[edit] Techbase page

Currently we use pages on Techbase to give verbose information about a BugDay and distribute work. A template URL for such a page is:

http://techbase.kde.org/Contribute/Bugsquad/BugDays/ProductDayX

Just replace Product with the application (eg. KWin) and X with the number of the BugDay (ie. 1 for the 1st BugDay for this application).

Notes:

• Use previous BugDay pages as a template.
• For triage, use a script to generate the batches (put scripts on svn, link here and put documentation somewhere)
• Make sure you adapt the page to the BugDay's needs.
• Make one or more developers check if they have special hints to add for the BugDay.

[edit] LiveCD

(to be written)

[edit] Marketing

Marketing should be somewhat coordinated. Be sure to distribute responsibilities in time.

• Create an article to be published on dot.kde.org. Make sure you submit it in time (2 weeks before the event!).
• Release informal follow-up blog posts on planetkde.org. Denominate the people who do that so there's no confusion.
• If possible get the triaged product's developers to blog about the BugDay as well asking their users to help.
• In addition you can translate the dot article to other languages and get people to post it on local KDE sites.
• Use micro-blogging to create some buzz (identi.ca, twitter).

(what should be in a dot article? to be written) (who to contact to publish the dot acrticle? to be written)

[edit] During the BugDay

During a BugDay new users will often join and either say nothing or just greet everyone. Most of the time those users need help but might be hesitant to ask. In the past it has often helped to check for new people joining and start talking to them when they do offering help. Thus at least one experienced member of BugSquad should always have an eye on IRC. It might be a good idea to designate someone to do that.

Apart from that:

• If there are new people around, keep an eye on what they do. Make them feel their work is appreciated, but also double-check some of it in order to avoid mistakes (we know we all made them when we started).
• Don't be shy to advertise our mailinglist.
• Make sure the BugDay is in the IRC channel's topic (as well as a link to the BugDay's Techbase page).
• If possible, make some of the application's developers join our IRC channel so they can help with certain bugs. Seeing your own work appreciated motivates.
• Be a bit verbose about what you're doing on IRC as to not make the channel seem too deserted. Seeing other people work might be motivating.

[edit] Checkpoints

(to be written, should contain a timetable of when you should do what when organizing a BugDay)

[edit] Templates

Find the templates for the BugDays here