Richtlinien zum Schreiben eines Bugreports

Grundsätze

Genau beschriebene Fehlermeldungen werden schneller behoben. Dieser Leitfaden erklärt, wie Sie solche Berichte schreiben sollten.

• Seien Sie präzise;
• Seien Sie klar - erklären Sie so, dass die anderen Ihren Bug nachvollziehen können;
• Beschreiben Sie nur einen Bug pro Meldung;
• Kein Bug ist zu banal, um gemeldet zu werden - kleine Bugs könnten größere Fehler verstecken;
• Trennen Sie Fakten klar von Vermutungen ab;
• Schreiben Sie die Bug-Meldung - wenn möglich - auf Englisch;

Vorbereitungen

1. Reproduzieren Sie Ihren Bug, indem Sie die neueste Version der Software benutzen, um zu sehen, ob der Bug schon behoben wurde.
2. Suchen Sie in Bugzilla, um zu sehen, ob Ihr Bug schon gemeldet wurde.

Einen neuen Bug melden

Wenn Sie den Bug in einer neuen Version reproduziert haben und noch niemand den Bug gemeldet hat, dann:

1. Wählen Sie "Einen neuen Bug melden"
2. Falls Sie noch keinen Bugzilla-Account haben, erstellen Sie hier einen
3. Loggen Sie sich ein
4. Wählen Sie das Produkt, in welchem Sie den Bug gefunden haben
5. Füllen Sie das Formular aus. Hier ist eine kleine Hilfe, um die Einzelheiten zu verstehen:

Component: In welchem Teil der Software besteht der Bug?

Dieses Feld wird benötigt. Klicken Sie auf "Component" um eine Beschreibung aller Komponenten zu sehen. Falls keins angebracht scheint, suchen Sie nach einer "General" Komponente.

Version: Das Feld zeigt die früheste Version, mit der der Bug nachgewiesen wurde. Entwickler benötigen diese Information, um die Code-Änderung, die das Problem verursacht, aufzuspüren. Außderdem dient die Versions-Information der Unterscheidung von Bugs mit unterschiedlichen Ursachen, aber ähnlchen oder gar gleichen Symptomen: Bugs, die defenitiv mit unterschiedlichen Produkt-Versionen auftraten, haben mit großer Sicherheit tatsächlich unterschiedliche Ursachen und sind keine DUPLICATEs.

OS: Auf welchem Betriebssystem haben Sie den Bug gefunden? (z.B. Linux, Windows XP, Mac OS X)

Wenn Sie wissen, dass der Bug auf mehreren Betriebssystemen besteht, klicken Sie "All". Wenn ihr Betriebssystem nicht aufgelistet ist, klicken Sie auf "Other".

Summary: Wie würden Sie den Bug beschreiben, möglichst in 60 oder weniger Buchstaben?

Eine gute Kurzfassung sollte eine Bug-Meldung schnell und unverwechselbar beschreiben. Sie sollte das Problem erklären, nicht Ihre vorgeschlagene Lösung.

• Gut: "Cancelling a File Copy dialog crashes File Manager" ("Wenn der Kopiervorgang einer Datei abgebrochen wird stürzt das Dateisystem ab")
• Schlecht: "Software crashes" ("Programm stürzt ab")
• Gut: "Down-arrow scrolling doesn't work in <textarea> styled with overflow:hidden" ("Pfeiltaste-nach-unten-scrollen funktioniert nicht in  <Textbereich> gestaltet mit overflow:hidden")
• Schlecht: "Browser should work with my web site" ("Browser sollte mit meiner Internetseite funktionieren")

Description: Die Details ihrer Bug-Meldung, einschließlich:

Overview: Detailliertere Beschreibung der Zusammenfassung.

Drag-selecting any page crashes Mac builds in the NSGetFactory function.

Steps to Reproduce: Kleine, einfache Schritte, um den Bug nachzumachen. Mit Hinweisen zum Setup.

1) View any web page. (I used the default sample page, 
resource:/res/samples/test0.html)

2) Drag-select the page. (Specifically, while holding down 
the mouse button, drag the mouse pointer downwards from any 
point in the browser's content region to the bottom of the 
browser's content region.)

Actual Results: Was die Applikation macht, nachdem Sie die oben aufgeführten Schritte durchgeführt haben.

The application crashed.

Expected Results: Was die Applikation hätte tun sollen, wenn der Bug nicht da wäre.

The window should scroll downwards. Scrolled content should be selected. 
(Or, at least, the application should not crash.)

Build Date & Platform: Datum und Betriebssystem auf dem die Applikation lief, als sie den Bug zum ersten Mal gesehen haben.

Build 2006-08-10 on Mac OS 10.4.3

Additional Builds and Platforms: Falls Sie wissen, dass der Bug auch in anderen Betriebssystemen (oder Browsern) auftritt (oder nicht), schreiben Sie dies dazu.

Doesn't Occur On Build 2006-08-10 on Windows XP Home (Service Pack 2)

Additional Information: Andere wichtige Informationen.

Für Bugs, die den Browser abstürzen lassen:

• Win32: Wenn Sie einen Dr. Watson-Fehler erhalten, notieren Sie bitte den Typ des Absturz und das Modul in welchem die Applikation abstürzte (z.B. "Access violation in mozilla.exe")
• Mac OS X: Wenn die Applikation abstürzt, klicken Sie den Report-Button im Bestätigungsfenster, das erscheint, kopieren Sie dann den ganzen Text, der unter der Nachricht "Problem and system information" erscheint und fügen Sie ihn in Ihre Bug-Meldung ein. Sie müssen die Meldung nicht an Apple senden, also klicken Sie nur auf den roten "Schließen"-Button am oberen Rand des Fensters
• Unix: Bitte stellen Sie einen minimierten Stack-Trace zur Verfügung, welche generiert werden kann, indem Sie gdb mozilla core in eine Eingabeaufforderung eingeben.

Date/Time:      2006-12-26 12:15:20.089 -0500
OS Version:     10.4.8 (Build 8L2127)
Report Version: 4

Command: firefox-bin
Path:    /Applications/Firefox.app/Contents/MacOS/firefox-bin
Parent:  WindowServer [71]

Version: 2.0.0.1 (2.0.0.1)

PID:    114
Thread: 0

Exception:  EXC_BAD_ACCESS (0x0001)
Codes:      KERN_PROTECTION_FAILURE (0x0002) at 0x000000ca

Thread 0 Crashed:
0   libxpcom_core.dylib 	0x0186329b AppendUTF8toUTF16(char const*, nsAString_internal&) + 31
1   libxpcom_core.dylib 	0x01822916 nsTextFormatter::smprintf_free(unsigned short*) + 3248
... (many many more lines like this) ...

Add an attachment: Sie können relevante Dateien an ihre Bug-Meldung anfügen. Debugging-Informationen, die länger als 20 Zeilen sind, sollten auf diesem Weg geliefert werden. Sollten Sie eine HTML-Datei haben, die diesen Bug beschreibt, sollten Sie sie anfügen. Sie können anfänglich nur eine Datei anfügen. Sollte ihre Meldung mehr Dateien angehängt haben, besuchen Sie den neu hinzugefügten Bug später noch einmal, um das zu tun. Hängen Sie zuerst untergeordnete Dateien an (z.B. Bilder) und ändern Sie anschließend die HTML-Datei, sodass die Demo unabhängig ist. Fragen Sie, bevor Sie mehr als 5 Dateien anhängen.

Prüfen Sie Ihren Report zweimal auf Fehler und drücken Sie dann "Commit". Ihre Bug-Meldung wird nun in die Bugzilla-Datenbank kommen.