Code Review: Unterschied zwischen den Versionen
Aus Das Sopra Wiki
Keine Bearbeitungszusammenfassung |
|||
| (5 dazwischenliegende Versionen von 2 Benutzern werden nicht angezeigt) | |||
| Zeile 1: | Zeile 1: | ||
{{TOCRight}}Im Softwarepraktikum werden ab Woche 3 ''Code Reviews'' des Projekts durch die Studenten gemacht. Die Dozenten machen ungefähr in der Mitte des Softwarepraktikums ein zusätzliches Code Review des Projekts. | {{TOCRight}}Im Softwarepraktikum werden ab Woche 3 ''Code Reviews'' des Projekts durch die Studenten gemacht. Die Dozenten machen ungefähr in der Mitte des Softwarepraktikums ein zusätzliches Code Review des Projekts. | ||
Ein Code Review soll jede Woche ein Task von ca. 2h sein und reihum von einem Gruppenmitglied erledigt werden. Ein Code Review sollte in seinem entsprechenden Gitea-Ticket einen Kommentar mit Erkenntnissen und -- falls sinnvoll -- einen Commit mit Verbesserungen bekommen. Die Erkenntnisse und Verbesserungen sollen im Sprint Review vom Reviewer | Ein Code Review soll jede Woche (als Teil der Aufgabe: Qualitätsicherung) ein Task von ca. 2h sein und reihum von einem Gruppenmitglied erledigt werden. Ein Code Review sollte in seinem entsprechenden Gitea-Ticket einen Kommentar mit Erkenntnissen und -- falls sinnvoll -- einen Commit mit Verbesserungen bekommen. Die Erkenntnisse und Verbesserungen sollen im Sprint Review vom Reviewer kurz zusammengefasst werden. | ||
==Ein Code Review Durchführen== | ==Ein Code Review Durchführen== | ||
| Zeile 48: | Zeile 48: | ||
Ein gutes Beispiel aus dem Softwarepraktikum ist: | Ein gutes Beispiel aus dem Softwarepraktikum ist: | ||
<syntaxhighlight lang=" | <syntaxhighlight lang="md">94cb043 see #27: Wayfinding improved to support bridges</syntaxhighlight > | ||
Ein schlechtes Beispiel ist: | Ein schlechtes Beispiel ist: | ||
<syntaxhighlight lang=" | <syntaxhighlight lang="md">959f313 Woololoo</syntaxhighlight> | ||
====Naming (und Coding Conventions)==== | ====Naming (und Coding Conventions)==== | ||
| Zeile 148: | Zeile 148: | ||
===Architektur=== | ===Architektur=== | ||
Prüfen Sie ob der Code den [https://sopranium.de/CleanCode#Prinzipien architektonischen Grundprinzipien] entspricht. | |||
---- | ---- | ||
*[https://google.github.io/eng-practices/review/reviewer/standard.html The Standard for Code Review] | *[https://google.github.io/eng-practices/review/reviewer/standard.html The Standard for Code Review] | ||
*[https://google.github.io/eng-practices/review/reviewer/looking-for.html What to look for in a Code Review] | *[https://google.github.io/eng-practices/review/reviewer/looking-for.html What to look for in a Code Review] | ||
*[https://github.com/google/eng-practices Google Engineering Principles Documentation] | *[https://github.com/google/eng-practices Google Engineering Principles Documentation] | ||
