Bewertung von Code Repositories
Bei der Bewertung von Projekten, die Code enthalten, schaue ich mir die unten aufgeführten Aspekte an. Diese Auflistung ist nicht abschließend, sondern dient als Anhaltspunkt.
Repo und Kooperation
- Repo enthält eine aussagekräftige ReadMe Datei.
- ADRs sind vorhanden, nachvollziehbar und fachlich angemessen
- Commits haben sinnvolle Größe und Beschreibung
- alle Projektteilnehmer haben Code beigesteuert
- Nutzung von Issues zur Organisation
- Nutzung eines sinnvollen Branching Konzepts
- Pull Requests werden genutzt, sowie sinnvoll und verantwortungsvoll eingesetzt
- ggf. Nutzung von Conventional Commits
- ggf. Nutzung von Projects o.Ä.
Code
- Technologie, Sprachen, Architektur sind fachlich angemessen ausgewählt und die Auswahl ist begründet
- Code ist sinnvoll strukturiert und nachvollziehbar
- Drittanbietercode wird explizit gemacht und der Einsatz begründet
- Code ist lokal ausführbar
- Anwendung ist deployed und jenseits von localhost erreichbar
- sinnvoller Einsatz von Modulen/ Komponenten, Klassen und Funktionen
- Nutzung sinnvoller Bezeichnungen für Module/ Komponenten, Klassen, Funktionen, Variablen, etc.
- keine Magic Numbers/ Words/ Urls
- Code ist schlank und aufgeräumt
- Code ist robust
- Implementierung ist angemessen (kein Over- oder Underengineering)