(:redirect 'http://docs.studip.de/develop/Entwickler/HowToReportBugs':)

Mit der Version wird erfaßt, ob sich ein Ticket auf das offizielle Stud.IP-Release bezieht (trunk) oder auf eine spezifische Standortversion von Stud.IP (studip-os o.ä.). Derzeit gibt es die folgenden Versionsbezeichner:

• per E-Mail an studip-users@lists.sourceforge.net

Fehlerbericht via E-Mail

Alternativ können Fehler auch per Mail an die Adresse studip-users@lists.sourceforge.net berichtet werden. Diese landen allerdings nicht automatisch in unserem Stud.IP-Ticketsystem, es kann daher gelegentlich passieren, daß diese längere Zeit unbearbeitet sind oder sogar wieder ganz in Vergessenheit geraten.

Daher sollten Fehler wenn möglich nicht via E-Mail berichtet werden, sondern über den unter 1.1 oder 1.2 genannten Weg.

Version

Cc

Priority

Component

Keywords

Der normale Weg, einen Fehler in Stud.IP zu melden, ist die Verwendung des entsprechenden Formulars in der Veranstaltung "Bugboard (BIESTs)" im Entwickler- und Anwenderforum. Voraussetzung dafür ist ein Account im Entwickler- und Anwenderforum (z.B. durch freie Registierung oder Shibboleth-Login). Der Begriff "BIEST" steht hier für Bug und Inkonsitenz Erkennung für Stud.IP.

1. Anmelden im Entwickler- und Anwenderforum

1. Anmelden im Trac (falls noch nicht geschehen)

Die erste Anlaufstelle für Erweiterungs- oder Verbesserungsvorschläge sollte das Forum der Veranstaltung Developer-Board im Entwickler- und Anwenderforum sein. Dort kann man mit den Stud.IP-Entwicklern diskutieren, ob und ggf. in welcher Forum die eigenen Ideen umgesetzt werden könnten. Verbesserungsvorschläge sollten (von Ausnahmefällen abgesehen) nicht ohne vorherige Diskussion ins Trac eingetragen werden.

Tickets, die als INVALID, WONTFIX, DUPLICATE oder WORKSFORME geschlossen werden, dürfen keinem Milestone zugewiesen sein.

Für die Meldung von Fehlern in Stud.IP gibt es verschiedene Wege:

Bitte geben Sie in jedem Fall unbedingt an:

Fehlerbericht über das Bugboard

Der normale Weg, einen Fehler in Stud.IP zu melden, ist die Verwendung des entsprechenden Formulars in der Veranstaltung "Bugboard (BIESTs)" im Entwickler- und Anwenderforum. Voraussetzung dafür ist ein Account im Entwickler- und Anwenderforum (z.B. durch freie Registierung oder Shibboleth-Login). Der Begriff "BIEST" steht dabei für Bug und Inkonsitenz Erkennung für Stud.IP.

Zum Eintragen eines neuen Fehlerberichts gehen Sie folgendermaßen vor:

1. Anmelden im Entwickler- und Anwenderforum
2. Die Veranstaltung "Bugboard (BIESTs)" aufrufen (ggf. als Teilnehmer eintragen).
3. Dort den Reiter "BIESTer" in der Navigation auswählen.
4. Auf dieser Seite den Link "BIEST melden" in der Navigation anklicken.
5. Im Formular eine kurze Zusammenfassung und eine längere Beschreibung des Fehlers eingeben.
6. Das Formular absenden.

1. Dort den Punkt "New Ticket" in der Navigation auswählen.
2. Im Formular eine kurze Zusammenfassung und eine längere Beschreibung des Fehlers eingeben.
3. Unter "Component" eine passende Kompontente auswählen (oder auf der Voreinstellung "Stud.IP allgemein" lassen).
4. Alle anderen Felder auf der Voreinstellung belassen.
5. Das Formular absenden.

Wie berichte ich einen Verbesserungsvorschlag?

Die erste Anlaufstelle für Erweiterungs- oder Verbesserungsvorschläge sollte das Forum der Veranstaltung Developer-Board im Entwickler- und Anwenderforum sein. Dort kann man mit den Stud.IP-Entwicklern diskutieren, ob und ggf. in welcher Forum die eigenen Ideen umgesetzt werden könnten. Verbesserungsvorschläge sollten (von Ausnahmefällen abgesehen) nicht ohne vorherige Diskussion ins Trac eingetragen werden.

Dieser Abschnitt ist für Entwickler gedacht, die im Umgang mit dem Trac schon etwas Erfahrung gesammelt haben und Tickets - d.h. Fehlerberichte oder konkrete Verbesserungsvorschläge - bearbeiten wollen.

• Lifters: eine langfristig angelegte Überarbeitung, muß zuvor von der Core-Group abgestimmt werden (trunk)
• StEP: ein Verbesserungsvorschlag, muß zuvor von der Core-Group abgestimmt werden (trunk)

Ein Milestone im Trac entspricht jeweils einem offiziellen Release von Stud.IP (wie 1.11.1 oder 1.12). Über die Milestone-Angabe im Ticket wird verwaltet, welche Tickets für welches Stud.IP-Release erfolgreich geschlossen worden sind oder noch erledigt werden müssen. Nur Tickets, die sich auf das offizielle Release beziehen, haben einen Milestone, und der Milestone sollte nur von der Person bearbeitet werden, der das Ticket zugewiesen ist (oder einem der Release-Verantwortlichen). Dabei gelten folgende Regeln:

BIEST

Ein offenes BIEST hat keinen Milestone. Wenn das BIEST geschlossen wird, gibt der Milestone die erste Version von Stud.IP an, die diese Korrektur enthält, das ist in der Regel der jeweils aktuelle Release-Branch.

StEP, TIC

Der Milestone ist die Version, für die der StEP bzw. TIC eingebaut werden soll.

Lifters

Ein Lifters hat keinen Milestone.

Tickets, die als WONTFIX, INVALID oder DUPLICATE geschlossen werden, dürfen keinem Milestone zugewiesen sein.

Mir der Version wird erfaßt, ob sich ein Ticket auf das offizielle Stud.IP-Release bezieht (trunk) oder auf eine spezifische Standortversion von Stud.IP (studip-os o.ä.). Derzeit gibt es die folgenden Versionsbezeichner:

• trunk: das offizielle Stud.IP-Release
• studip-os: das Stud.IP der Uni Osnabrück
• studip-fhos: das Stud.IP der FH Osnabrück
• forschdb-os: die Forschungsdatenbank der Uni Osnabrück

Wenn eine weitere Standortversion in die Auswahlliste im Trac aufgenommen werden soll, wenden Sie sich bitte an einen der Trac-Administratoren (Elmar Ludwig, André Noack, Marcus Lunzenauer).

Cc

Hier können weitere Personen eingetragen werden, die über den Stand des Tickets informiert werden sollen. Eingetragen werden können Account-Namen und/oder Mail-Adressen (jeweils durch Komma getrennt).

Priority

Über das Feld Priority kann der Besitzer des Tickets (d.h. der dem Ticket zugewiesene Entwickler) notieren, wie wichtig die Korrektur eines bestimmten Problems ist. Die Voreinstellung ist hier "normal".

Component

Die Komponente gibt den Bereich von Stud.IP an, auf das sich das Ticket beziegt. Es gibt eine vorgegebene Liste von Komponenten wie "Forum", "Nachrichten / Kontakte" oder "Veranstaltungen". Alles, was nicht in eine der Standardkategorieren hineingehört, sollte unter "Stud.IP allgemein" eingetragen werden. Das ist auch die Voreinstellung.

Keywords

Über die Standardattribute hinausgehende Markierungen an einem Ticket werden über Keywords abgebildet. Derzeit werden folgende Keywords verwendet:

• review?: Code-Review notwendig
• review+: Code-Review positiv
• review-: Code-Review negativ, d.h. Veto des Verantwortlichen
• security?: Security-Review notwendig
• security+: Security-Review positiv
• security-: Security-Review negativ, d.h. Veto des Verantwortlichen

• In welcher Stud.IP-Version bzw. an welchem Standort tritt der Fehler auf? (z.B.: Version 1.11, Uni Göttingen)
• Welchen Browser in welcher Version verwenden Sie? (z.B.: Internet Explorer 7)
• In welcher Rolle sind Sie im System unterwegs? (z.B. "Dozent")
• Beschreiben Sie möglichst genau, was unter welchen Umständen getan werden muß, um den Fehler zu reproduzieren.

Fehlerbericht über das Trac

Für etwas erfahrene Entwickler und Anwender gibt es auch die Möglichkeit, einen Fehlerbericht direkt als "Ticket" in das Trac einzutragen. Voraussetzung dafür ist ein Account im Entwickler- und Anwenderforum, der als Teilnehmer in die Veranstaltung "Bugboard (BIESTs)" eingetragen ist. Mit diesem Account kann man sich dann auch im Trac anmelden.

Zum Eintragen eines neuen Tickets gehen Sie folgendermaßen vor:

1. Anmelden im Trac (falls noch nicht geschehen)
2. den Punkt "New Ticket" in der Navigation auswählen
3. Im Formular eine kurze Zusammenfassung und eine längere Beschreibung des Fehlers eingeben
4. unter "Component" eine passende Kompontente auswählen (oder auf der Voreinstellung "Stud.IP allgemein" lassen)
5. die anderen Felder auf der Voreinstellung belassen
6. das Formular absenden

Wie berichte ich einen Verbesserungsvorschlag

Die erste Anlaufstelle für Erweiterungs- oder Verbesserungsvorschläge sollte das Forum der Veranstaltung Developer-Board im Entwickler- und Anwenderforum sein. Dort kann man mit den Stud.IP-Entwicklern diskutieren, ob und ggf. in welcher Forum die eigenen Ideen umgesetzt werden könnten.

Verwaltung von Tickets im Trac

Dieser Abschnitt ist für Entwickler gedacht, die im Umgang mit dem Trac schon etwas Erfahrung gesammelt haben und Tickets (d.h. Fehlerberichte oder konkrete Verbesserungsvorschläge) bearbeiten wollen.

Typen von Tickets

Es gibt folgende Ticket-Typen:

• BIEST: ein Fehler im offiziellen Release (trunk)
• Lifters: eine langfristig angelegte Überarbeitung, muß zuvor von der Core-Group abgestimmt werden (trunk)
• StEP: ein Verbesserungsvorschlag, muß zuvor von der Core-Group abgestimmt werden (trunk)
• TIC: ein "kleiner" Verbesserungsvorschlag (trunk)
• defect: ein Fehler in einer speziellen Standortversion
• enhancement: ein Verbesserungsvorschlag für eine spezielle Standortversion
• task: ein nicht codebezogenes Ticket (Update des Trac o.ä.)

Milestone

Über die Milestones wird verwaltet, welche Tickets für welches Stud.IP-Release erfolgreich geschlossen worden sind oder noch erledigt werden müssen. Dabei gelten folgende Regeln:

• Der Milestone sollte nur von der Person bearbeitet werden , der das Ticket zugewiesen ist (oder einem der Release-Verantwortlichen).
• Offene Tickets sollten nur dann einen Milestone besitzen, wenn es erforderlich ist, sie für ein entsprechendes Release zu erledigen (BIEST) oder vom Ersteller zugesagt wurde, eine entsprechende Verbesserung bis dahin einzubauen (StEP, TIC).
• Der Milestone gibt die kleinste Version von Stud.IP an, welche die Korrektur (bzw. Verbesserung) enthält, das ist bei einem BIEST in der Regel der aktuelle Release-Branch.
• Tickets, die als WONTFIX, INVALID oder DUPLICATE geschlossen werden, dürfen keinem Milestone zugewiesen sein.

Wichtig: Der Milestone gibt nicht an, in welcher Version der Fehler aufgetreten ist. Das sollte Teil des Beschreibungstextes sein.

Version

Mir der Version wird erfaßt, ob sich ein Ticket auf das offizielle Stud.IP-Release bezieht (trunk) oder auf eine spezifische Standortversion von Stud.IP (studip-os o.ä.).

Wenn eine weitere Standortversion in die Auswahlliste im Trac aufgenommen werden soll, wenden Sie sich bitte an einen der Trac-Administratoren.

< Überblick | Entwicklungs-HOWTO | Entwicklungssystem aufsetzen >

Entwicklungs-HOWTO: Fehler berichten

(:toc:)

Für Meldung und Verwaltung von Fehlern wird das Trac auf dem Entwicklungsserver verwendet. Dort sind alle bekannten und behobenen Fehler dokumentiert, und auch die Planung für die zukünftigen Stud.IP-Releases wird dort organisiert.

Wie berichte ich einen Fehler?

Fur die Meldung von Fehlern in Stud.IP gibt es verschiedene Wege:

• per E-Mail an studip-users@lists.sourceforge.net
• über das Formular in der Veranstaltung Bugboard (BIESTs) im Entwickler- und Anwenderforum (Registrierung erforderlich)
• direkt über ein Formular im Trac (Registrierung im Entwickler- und Anwenderforum erforderlich)

Bitte geben Sie in jedem Fall unbedingt an:

1. In welcher Stud.IP-Version bzw. an welchem Standort tritt der Fehler auf? (z.B.: Version 1.11, Uni Göttingen)
2. Welchen Browser in welcher Version verwenden Sie? (z.B.: Internet Explorer 7)
3. In welcher Rolle sind Sie im System unterwegs? (z.B. "Dozent")
4. Beschreiben Sie möglichst genau, was unter welchen Umständen getan werden muß, um den Fehler zu reproduzieren.

Wie bereichte ich einen Verbesserungsvorschlag

Die erste Anlaufstelle für Erweiterungs- oder Verbesserungsvorschläge sollte das Forum der Veranstaltung Developer-Board im Entwickler- und Anwenderforum sein. Dort kann man mit den Stud.IP-Entwicklern diskutieren, ob und ggf. in welcher Forum die eigenen Ideen umgesetzt werden könnten.