Gerüst für Fehlerbeschreibungen
Aus SUE
Inhaltsverzeichnis |
Je besser ein Fehler beschrieben wird, desto leichter kann er nachvollzogen und (hoffentlich) schnell behoben werden. Die nachfolgenden Angaben sollen daher als Gerüst für Fehlerbeschreibungen dienen.
Wer möchte, kann Fehler (bitte auf englisch) direkt in den SUE-Bug-Tracker auf SourceForge.net eintragen. Ansonsten kann die Fehlerbeschreibung auch per E-Mail an uns geschickt werden (gerne auch auf deutsch).
Grundsätzliches
- Benötigt wird eine präzise und klare Beschreibung, anhand derer andere (das SUE-Team) den Fehler reproduzieren können.
- Bitte nur einen Fehler pro Bericht melden.
- Kein Fehler ist zu simpel um ihn zu melden - kleine Fehlen könnten große Fehler verdecken.
- Bitte Fakten von Spekulationen klar unterscheiden.
Vor dem Verfassen einer Fehlerbeschreibung
- Den Fehler bitte mit einer aktuellen Version von SUE (letzte SVN-Revision) reproduzieren. Vielleicht wurde er bereits behoben.
- Im Bug-Tracker auf SourceForge.net nachsehen, ob der Fehler bereits gemeldet wurde.
- SUE aus dem Gnome-Terminal heraus starten und evtl. auftretende Fehlermeldungen in den Fehlerbericht kopieren oder
- SUE aus dem Gnome-Terminal heraus mit der Option -l debug starten. Damit werden alle Level der Logausgaben ausgegeben.
- Zusätzlich kann die Option --log-file=sue.log verwendet werden, die diese Log-Ausgaben in eine Datei 'sue.log' schreibt. Diese Datei kann dann dem Fehlerbericht beigefügt werden kann.
Nützliche Angaben
- Linux-Distribution und -Version, Kernel-Version und SUE-Revision (Befehl 'svn info' im SUE-Homeverzeichnis)
- Zusammenfassung der Fehlerbeschreibung
- Schritte zum Reproduzieren des Fehlers
- Welche Programme / Fenster wurden geöffnet? (Versionsnummer des betreffenden Programms)
- Bei Fehlern im Zusammenhang mit einem Webbrowser: Welche URL wurde aufgerufen?
- Welche Einstellungen wurden bei SUE getätigt?
- Welche Tastenkürzel wurden für die einzelnen Schritte verwendet?
- Auftretendes Ereignis (inkl. Fehlermeldung auf Konsole, Log-Ausgabe als Anhang)
- Was passiert, nachdem die oben beschriebenen Schritte ausgeführt wurden?
- Erwartetes Ereignis
- Welches Verhalten wird von einer fehlerfreien SUE erwartet?
- Zusätzliche Informationen, die hilfreich sein könnten
- Priorität: 1 bis 9
- 1 = Niedrigste Priorität: Wenn Zeit dafür vorhanden ist
- 9 = Höchste Priorität: Muss unbedingt behoben werden
- Schweregrad:
- Blocker: Keine weiteren Tests mit der Applikation möglich
- Kritisch: Programmabsturz, Datenverlust
- Schwer: Schwerwiegender Funktionalitätsverlust
- Mäßig: Wahrnehmbarer Funktionalitätsverlust
- Gering: Bedarf kleinerer Verbesserung
- Verbesserung: Anfrage eines neuen Features oder einer Verbesserung eines bestehenden Features (Feature Request)
- Fehlertyp:
- Programmierfehler
- Designfehler
- Vorschlag
- Problem mit der Dokumentation
- Problem mit spezieller Hardware
Quellen
Noch was
Vielen Dank für Eure Mühe!
