From 330b7ff57fae769c0e127f079685d2a291396177 Mon Sep 17 00:00:00 2001 From: Hatice Yildirim <Hatice.Yildirim@student.reutlingen-university.de> Date: Sun, 13 Apr 2025 20:13:48 +0200 Subject: [PATCH] Add prompts for TDD implementation and testing in Assignment 02 Designs a prompt that generates a well-formulated commit message based on a given task description. The prompt follows Chris Beams' 7 rules for meaningful commit messages and ensures clarity, structure, and consistency when documenting code changes. --- README.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 98488cf..8a4ed6e 100644 --- a/README.md +++ b/README.md @@ -94,4 +94,14 @@ Jede Regel sollte einzeln bewertet werden. Gib zu jeder Regel eine Punktzahl von Addiere die Punktzahlen aus den einzelnen Regeln. Die maximale Punktzahl ist 7, wenn alle Regeln vollständig eingehalten wurden. - Gesamtbewertung (0–7) \ No newline at end of file + Gesamtbewertung (0–7) + +# Optional Assignment - Create a Commit Message using Prompt Engineering + +## Promt: +| Commit-Promt | Commit-Nachricht | Bewertung | +|-------------------------------------------------------------|--------------------------------|-----------| +| Erstelle eine Git-Commit-Nachricht für die folgende Aufgabe:"Schreibe Methode convert(n: int) -> str, die eine Zahl in einen String umwandelt." Die Commit-Nachricht soll den 7 Regeln für gute Git-Commit-Nachrichten von Chris Beams folgen: https://cbea.ms/git-commit/#seven-rules | Schreibe Methode convert(n: int) -> str zur Umwandlung einer Zahl in String <br> <br> Dieser Commit fügt die Methode convert(n: int) -> str hinzu, die eine ganzzahlige Eingabe in eine String-Repräsentation der Zahl umwandelt. Die Methode bietet eine einfache Möglichkeit, Zahlen in einen für Ausgaben geeigneten Format zu konvertieren.<br> <br> Diese Implementierung deckt die grundlegende Umwandlung ab und ist auf erweiterbare Anforderungen ausgelegt. | 6 | +| Erstelle eine Git-Commit-Nachricht für die folgende Aufgabe:"Implementiere Calculator.add(a, b)-Methode und schreibe dazu einen Unit-Test." Die Commit-Nachricht soll den 7 Regeln für gute Git-Commit-Nachrichten von Chris Beams folgen: https://cbea.ms/git-commit/#seven-rules | Implementiere Methode add(a, b) in Calculator mit Unit-Test <br> <br> Dieser Commit fügt die Methode add(a, b) zur Calculator-Klasse hinzu und ergänzt einen zugehörigen Unit-Test. Die Methode gibt die Summe der beiden übergebenen Zahlen zurück. <br> <br> Der Test stellt sicher, dass die Addition korrekte Ergebnisse für typische Eingabewerte liefert und die grundlegende Funktionalität abgedeckt ist. | 7 | +| Erstelle eine Git-Commit-Nachricht für die folgende Aufgabe:"Füge Test für andere Studenten-Implementierungen hinzu (other.student.Calculator)" Die Commit-Nachricht soll den 7 Regeln für gute Git-Commit-Nachrichten von Chris Beams folgen: https://cbea.ms/git-commit/#seven-rules | Füge Test für andere Studenten-Implementierungen hinzu <br> <br> Dieser Commit ergänzt einen Test, der gezielt die Implementierungen anderer Studierender testet, insbesondere die Klasse other.student.Calculator. Ziel ist es, die Kompatibilität und Korrektheit der eigenen Lösung im Vergleich zu alternativen Implementierungen sicherzustellen. <br> <br> Der Testlauf kann bei der Validierung im Rahmen von Übungen oder Abgabenprozessen eingesetzt werden.| 6 | +| Erstelle eine Git-Commit-Nachricht für die folgende Aufgabe:"Füge Testlauf hinzu, bei dem andere Tests gegen deine Implementierung laufen" Die Commit-Nachricht soll den 7 Regeln für gute Git-Commit-Nachrichten von Chris Beams folgen: https://cbea.ms/git-commit/#seven-rules | Füge Testlauf hinzu für Ausführung anderer Tests gegen eigene Lösung <br> <br> Dieser Commit ergänzt einen Testlauf, bei dem vorhandene Tests gegen die eigene Implementierung ausgeführt werden. Dadurch kann sichergestellt werden, dass die Lösung mit den bestehenden Erwartungen übereinstimmt und korrekt funktioniert. <br> <br> Der Testlauf kann sowohl manuell als auch im Rahmen automatisierter Testprozesse verwendet werden.| 6 | \ No newline at end of file -- GitLab