Locked History Attachments

ChangeRequestTemplate

Wie fülle ich das hier aus?

  1. Überschrift anpassen: "Summary of problem description" ersetzen durch einen knappen Titel für die geplante Änderung

  2. Problembeschreibung formulieren: was lief falsch (actual behavior)? Wie hätte es funktionieren sollen / was ist das erwartete Programmverhalten? Bei offensichtlichen Erwartungen (Crash wird vermieden) kann dieser Punkt entfallen oder extrem knapp sein.

  3. Problemanalyse (Cause of the bug): was hat sich als Ursache des Problems herausgestellt? Ziel von Änderungen ist hier immer Ursachen- und nicht Symptombekämpfung.

  4. Änderungplan (Proposed solution): was muß am Code verändert werden, damit die Ursache vermieden wird? Möglichst knapp und trotzdem präzise schreiben. Falls möglich auch Patch anhängen, das erhöht das Verständnis teilweise.

  5. Affected classes: einfach nur eine Liste mit Dateinamen, wenn es geht mit ganzem Pfad (dann findet mans schneller). Eine Liste mit Dingen, die "auch noch betroffen" sein können, ist eine Übung, um die Testmaßnahmen vollständig zu bekommen.

  6. Test: Bester und empfohlener Weg: Testcase anpassen oder schreiben, um das Problem verläßlich zu reproduzieren. Falls nicht durchführbar: beschreiben, was man von Hand ausprobieren kann (welche Applikation startet man, was klickt man, was sollte dann passieren?)

  7. Die Frage-Blöcke in Klammern weglöschen (die sind als Hilfestellung gedacht)
  8. Diese Warnmeldung (im Quelltext ein Block in geschweiften Klammern) entfernen

Summary of problem description

Actual behavior

Expected behavior

Cause of the bug

(How could this happen?, what went wrong?)

Proposed solution

(How do I plan to fix this? Other solutions?)

Affected classes

(Which classes will be modified?, Which other classes/modules could be affected by the proposed change?)

How will the bugfix get tested?

(unit test possible?, manual test necessary? how can it be tested?)

If this is a non-trivial issue (such as 0.5 pixel offsets, geometry calculation problems, pixel interpolation, etc.), then DO NOT put "manual testing" here. Instead, describe, what is actually done to verify the fix. E.g. describe

  • what images/data are used to perform the verification?
    • is there any underlying system that ensures all causes of failure are covered by the test?
  • what does the user do?
  • how did the user know the bug is not present anymore?