Symbol Inhaltsseite

Handreichung Bug-Report

Reiter

Willkommen zum ILIAS-Bug Leitfaden!

Dieser Leitfaden richtet sich an die Service-Stellen der Hochschulen und zielt darauf ab, die Mitarbeiter*innen zu mittels einer Anleitung zu unterstützen, eigenständig Bugs zu melden. Mit der Meldung und damit auch Behebung von Bugs wird schlussendlich dann auch ILIAS als Lehr- und Lernplattform nachhaltig gestärkt.

Die aktive Beteiligung der Hochschul-Service-Stellen bei der Meldung von Bugs spielt eine entscheidende Rolle für die fortlaufende Verbesserung von ILIAS. Als direkte Anlaufstelle von Lehrenden und Studierenden könnt ihr auftretende Probleme effektiv erkennen und melden. Eure Rückmeldungen ermöglichen es dem ILIAS-Entwickler*innen, rasch auf Schwachstellen zu reagieren und gezielte Lösungen zu entwickeln.

Für dein Erwartungsmanagement ist es wichtig zu wissen, dass die Bearbeitungsdauer Seitens der Entwickler*innen je Bugmeldungen stark variieren kann. Die Bearbeitungsdauer wird vor allem von der Schwere des Fehlers, der Komplexität der Lösung und der aktuellen Arbeitslast beeinflusst.
In den nächsten 6 Schritten erfährst du, wie du ein Bug in ILIAS meldest:
Bevor wir den Bug offiziell melden, versuche das Problem schriftlich zu reproduzieren. Achte auf folgende besondere Anforderungen:
  • Lege dar, an welcher Komponente von ILIAS der Bug aufgetaucht ist. Eine Komponente kann ein ILIAS-Objekt (z.B. Übung) oder ein Gestaltungswerkzeug (z.B. Seiteneditor) sein
  • Überprüfe, ob bei Komponenten, die an verschiedenen Stellen eingesetzt werden, der Bug auch in anderen ILIAS-Objekten mit derselben Komponente auftaucht (z.B. Seiteneditor in verschiedenen Objekten)
Hinweis:
Hochschulintern Bugs melden - Mach dich schlau, ob es an deiner Hochschule ggf. Personen gibt, die das Bug-Melden in ihrer Funktion für dich übernehmen können. 
Um zu klären, ob der Bug ein Fehler des Hochschul-ILIAS ist oder ob es sich um einen allgemeinen Bug von ILIAS handelt, prüfe bitte den Bug wie folgt:
  • Identifiziere den Bug  auf einer hochschulinternen Test-Instanz. Prüfe, ob der Bug vorhanden bzw. nicht vorhanden ist. Wenn dieser nicht vorhanden ist, dann ist es ein Bug, der sich nur auf deinem Hochschul-ILIAS zu finden ist. Das kannst du dann hochschulintern weitergeben. 
  • Identifiziere den Bug auf einer offiziellen Test-Instanz vom ILIAS-Verein. Auf der offiziellen Test-Instanz findest du ILIAS im Standard-Modell ohne etwaige Anpassungen deiner Hochschule.
    • Um in einem ersten Schritt zu klären, ob der Bug von einer spezifischen ILIAS-Version abhängig ist, identifiziere den Bug auf der ILIAS-Instanz mit derselben Major-Version. Teste zudem, ob der Bug auch weiterhin bei höheren Major-Version vorliegt, die noch nicht an deiner Hochschule angeboten wird. 
      • Wenn der Bug auf der ILIAS-Instanz mit der derselben Major-Version nachweisbar ist, aber nicht mehr bei höheren Major-Versionen, dann ist der Bug bereits für die nächsten Major-Versionen beseitigt. Kläre hochschulintern, wann bei euch das Update auf die nächsthöhere Version geplant ist. 
      • Wenn du den Bug auf der aktuell höchsten ILIAS-Instanz nachweisen kannst, fahre mit Schritt 3 fort. 
Hinweis:
Hier gelangst du zur aktuellen Standard-ILIAS-Instanz:
Version 7: https://demo.ilias.de/
Version 8: https://demo8.ilias.de/
Um Bugs zu erfassen, arbeitet die ILIAS-Community mit dem Mantis Bugtracker. Mantis ist ein webbasiertes System zur Verwaltung und Verfolgung von Bugs. Die Maintainer von ILIAS erfahren durch Mantis den Bug und können diesen dann beheben. Bevor du in Mantis einen neuen Bugreport erstellst, durchsuche bitte Mantis nach ähnlichen Bugs, um Duplikate zu vermeiden. Gehe wie folgt vor:
  • Melde dich kostenfrei bei Mantis an
  • Wähle oben rechts in Mantis "ILIAS Core" für ILIAS-spezifische Bugs und "ILIAS Plugins" für Plugin-bezogene Bugs
  • Klicke auf "Einträge anzeigen" im Navigations-Menü (links)
  • In der oberen blauen Box "Filterung" gibt es mehrere Möglichkeiten, um nach deinem festgestellten Bug zu suchen
    • Filterung nach Kategorie: Kategorie können ILIAS-Objekte und weitere Komponenten von ILIAS sein
    • Filterung nach Major-Version: Wähle aus, in welcher Major-Version dein Bug aufgetreten ist
    • Filterung nach Stichworten: Beschreibe dein Bug in kurzen, prägnanten Stichworten. Wahlweise in Deutsch & Englisch. Probiere mehrere Stichwörter aus. 
    • Wichtig: Filtere nicht nach dem "Status":: Auch geschlossene Bugreports können für dich relevant sein und sollten berücksichtigt werden. 
  • Falls du einen bereits gemeldeten Bug gefunden hast, der mit deinen eigenen Problembeschreibung übereinstimmt oder ähnlich ist, kannst du je nach Status wie folgt in Mantnis vorgehen:
    • Status "resolved": Wiedereröffne den Bugreport und füge über das Notiz deine eigenen Informationen hinzu (Version, fehlerhaftes ILIAS-Objekt, usw) 
    • Status "closed": Prüfe den Grund, wieso der Report bereits als abgeschlossen galt. Wenn notwendig, wiedereröffne den Bugreport und füge unter Notizen deine aktuellen Informationen hinzu.
    • Bei allen anderen Stati ausser resolved und closed: Füge eine Notiz mit deinen eigenen Informationen hinzu
    • Bugreport "Beobachten": Wenn du mit dem bereits getätigten Bugreport einverstanden bist, dann beobachte den Report, um Benachrichtigungen per E-Mail zu erhalten. 
Hinweis:
Hier kannst du dich für den Bugtracker Mantis anmelden.
Wenn du nach dem dritten Schritt festgestellt hast, dass dein Bug noch nicht gemeldet worden ist, kannst du auf Mantis wie folgt deinen Bug melden:
  • Kicke auf "Eintrag erfassen" im Navigations-Menü (links)
  • Wähle "ILIAS Core" für ILIAS-spezifische Bugs und "ILIAS-Plugins" für Plugin-bezogene Bugs und klicke auf "Projekt wählen"
  • Es öffnet sich ein Fenster, in dem du die Details deines Bugreports festhalten kannst:
    • Kategorie: Wähle die betroffene Komponente aus (z.B. Test & Assessment)
    • Reproduzierbarkeit: Wenn du die Schritte 1 und 2 dieser Handreichung erfolgreich durchgeführt hast, wähle die Option "Immer". Die anderen Möglichkeit wählst du bei Bedarf nach deiner persönlichen Einschätzung
    • Schweregrad: Hier wählst du dein Schweregrad deines Bugs. In den meisten Fällen ist "Kleinerer Fehler" angemessen. "Schwerer Fehler" oder "Absturz" soll nur gewählt werden, wenn dein Hochschul-ILIAS an der betroffenen Bug-Komponente nicht mehr nutzbar ist. Die anderen Möglichkeiten wählst du nach deiner persönlichen Einschätzung. 
    • Priorität: Die Priorität sollte standardmäßig auf "Normal" bleiben. Die Entwickler*innen passen dies an.. 
    • Produktversion: Nenne die höchste ILIAS-Version, bei der Problem aufgetreten ist. Gebe ggf. unter Beschreibung weitere betroffene Versionen an.
    • Zusammenfassung: Wähle einen passenden Titel für den Bugreport. Idealerweise beschreibst du bereits im Titel den Fehler und die daraus resultierende Wirkung, z.B. "Click on Start Test does not work".
    • Beschreibung: Beschreibe in kurzen, prägnanten Sätzen die Details zu deinem Bugreport:
      • Beschreibe, wann der Bug auftritt und welche Folgen er hat
      • Füge den Link zu der ILIAS-Komponente (z.b. dem betroffenen ILIAS-Objekt) auf der offiziellen Testinstanz hinzu, bei dem der Bug nachgewiesen wurde oder werden kann.
      • Falls bekannt, gib die Ursache und einen möglichen Lösungsansatz an. 
      • Nenne weitere ILIAS-Versionen, bei denen der Bug ebenfalls auftritt.
    • Schritte zur Reproduktion: Erkläre genau wie in einer Klickanleitung, welche Klicks oder Aktionen erforderlich sind, um den Bug zu reproduzieren.
    • Zusätzliche Informationen: Füge zusätzliche Informationen hinzu, wenn vorhanden, wie detaillierte Fehlercodes oder technische Details.
    • Tags zuordnen (optional): Füge Tags hinzu, um den Bug besser zu kategorisieren und zu filtern.
    • Database, Engine, Web Server: Das kannst du beim Standard belassen. Es wird frühestens relevant, wenn es sich um "technische" Bugs handelt.
    • Dateien übertragen: Falls möglich, kannst du Dateien übertragen, wie Screenshots oder Screencasts, um den Bug zu veranschaulichen. Ebenso sollten relevante Dateien zur Reproduktion des Bugs hochgeladen werden, wie Import-Dateien.
  • Wenn du die oben beschriebenen Felder ausgefüllt hast, kannst du auf "Eintrag absenden" klicken
  • Du erhältst von Mantis eine automatische E-Mail Benachrichtigung, wenn sich am Bug etwas ändert. In der Regel wird sich über den Bug-Report der zuständige Maintainer bei dir melden, um an einer Lösung zu arbeiten. 
Hinweis:
Hier auf der docu-Seite von ILIAS findest du den offiziellen Leitfaden des ILIAS Vereins fürs das Melden von Bugs. 
Dein gemeldeter Bug-Report wird in der Regel von den Maintainern angenommen und bearbeitet. Falls du über einen längeren Zeitraum keine Rückmeldung zu deinem Report erhalten hast, kannst du wie folgt vorgehen:
  • Frage in Mantis über eine Notiz nach, was der aktuelle Stand zu deinem Bug ist bzw. ob weitere Informationen zur Behebung benötigt werden. 
  • Voten: Jedes institutionelles Mitglied im ILIAS-Verein hat eine Person, die für den Bug-Report voten kann. Wenn du zum Beispiel weitere Hochschulen in NRW auf deinen Bug aufmerksam machst und sie davon überzeugst für die Behebung deines Bugs zu voten, steigt die Wahrscheinlichkeit einer schnellen Behebung.  
  • ILIAS JourFixe: Es gibt Fälle, bei denen die Behebung des Bugs  das Verhalten von ILIAS verändern wird oder anderweitig Diskussionsbedarf besteht. In den Fällen wird der Bug und seine Behebung im ILIAS Jour Fixe vorgestellt. Keine Angst: In der Regel wird der Maintainer den Bug vorstellen und seine Einschätzung dazu teilen. Für dich wäre es wichtig, bei dem ILIAS JourFixe teilzunehmen, damit du etwaige Fachfragen zu dem Bug beantworten kannst.
Wenn der Status auf "fixed" gesetzt wurde, sollte der Bug mit dem nächsten Minor Update behoben sein. Sobald das nächste Minor Update in deiner Lokalen Installation erfolgt ist, solltest du auf der offiziellen Test-Instanz von ILIAS überprüfen, ob der Bug behoben ist. Falls nicht, kannst du den Bug-Report wiedereröffnen. 
Wieso ist es wichtig den Bug zu melden?
ILIAS ist eine Open Source Software, die sich auf eine engagierte Community stützt. Vor dem Release einer neuen ILIAS-Version gibt es umfangreiche Tests, um Softwarefehler (Bugs) zu beseitigen.
Einige Bugs werden nichtsdestotrotz erst beim realen Einsatz der neuen ILIAS-Version bemerkt. Um die Qualität von ILIAS stetig zu erhöhen, Sicherheitslücken zu schließen und  Bugs zu beseitigen, brauchen die Entwickler*innen Feedback von Nutzer*innen. Studierende und Lehrende einer jeden Hochschule gehören zu den größten Nutzer*innen von ILIAS und können wertvolle Bug-Hinweise geben, die von den Service-Stellen in die ILIAS-Community hineingegeben werden. Hochschulen gehören zu den größten Nutzer*innen von ILIAS.
Werde teil der Community und unterstütze ILIAS durch Bugreports für alle besser zu machen.