GitHub Template Repositories: Served Domains, Maintenance, and Practitioner Guidelines
Diese Arbeit präsentiert eine groß angelegte empirische Studie über GitHub-Template-Repositories über fünf Programmiersprachen hinweg, um deren Anwendungsbereiche, Wartungsmerkmale und Qualitätsprobleme zu analysieren und letztlich praktische Leitlinien für das Design und die Verwaltung effektiver Template-Projekte abzuleiten.
Originalarbeit lizenziert unter CC BY 4.0 (http://creativecommons.org/licenses/by/4.0/). Dies ist eine KI-generierte Erklärung des untenstehenden Papers. Sie wurde nicht von den Autoren verfasst oder gebilligt. Für technische Genauigkeit konsultieren Sie das Originalpaper. Vollständigen Haftungsausschluss lesen
Stellen Sie sich GitHub als einen riesigen, geschäftigen digitalen Marktplatz vor, auf dem Entwickler Blaupausen für den Bau von Software teilen. Jahrelang war der Hauptweg, wie Menschen diese Blaupausen teilten, indem sie einen „Fork“ erstellten – so als würde man die Pläne eines Hauses kopieren, sie auf sein eigenes Grundstück bringen und sie dann nach seinen eigenen Vorstellungen umbauen.
Doch im Jahr 2019 führte GitHub eine neue Funktion ein: Template-Repositories. Betrachten Sie diese nicht als Kopien eines fertigen Hauses, sondern als vorgefertigte Starter-Kits. Anstatt Ihnen ein Haus zu geben, das Sie umbauen müssen, gibt Ihnen ein Template ein perfektes Fundament, die richtige Wasserverlegung und die korrekte Verkabelung für ein neues Haus, das Sie gleich bauen werden. Es ist, als würde man aus einem Katalog ein „Haus-Kit“ kaufen, anstatt ein gebrauchtes Haus zu kaufen und es abzureißen.
Diese Arbeit ist eine groß angelegte Untersuchung dieser Starter-Kits. Die Forscher stellten drei große Fragen: Welche Arten von Häusern bauen die Menschen mit diesen Kits? Sind die Kits zuverlässig? Und wie können wir in Zukunft bessere Kits erstellen?
Hier ist das, was sie herausgefunden haben, einfach aufgeschlüntelt:
1. Wofür werden diese Kits verwendet? (Die Domänen)
Die Forscher untersuchten tausende dieser Templates über fünf große Programmiersprachen hinweg (wie Python, JavaScript und Java).
- Der große Gewinner: Webentwicklung ist mit Abstand der beliebteste Anwendungsfall. Es ist so, als würde man feststellen, dass 60–70 % aller Starter-Kits im Laden für den Bau von Websites gedacht sind. Das ergibt Sinn, da Sprachen wie JavaScript und TypeScript die primären Werkzeuge für den Bau des Internets sind.
- Die Spezialisten: Einige Sprachen sind spezialisierter. Zum Beispiel sind Python-Templates die „Schweizer Taschenmesser“ unter den Beteiligten; sie decken alles von Websites bis hin zu Künstlicher Intelligenz und Datenwissenschaft ab. Im Gegensatz dazu sind C#- und Java-Templates oft auf spezifische Dinge wie Videospiele oder Unternehmenssoftware fokussiert.
- Wer stellt sie her? Interessanterweise werden die meisten dieser Kits von Einzelpersonen erstellt, nicht von großen Unternehmen. Es ist wie eine Nachbarschaft, in der die meisten Menschen DIY-Enthusiasten sind, die ihre eigenen Blaupausen teilen, anstatt dass eine Baukonzern etwas verkauft.
2. Sind die Kits zuverlässig? (Wartung & Qualität)
Wenn Sie ein Haus-Kit kaufen, wollen Sie wissen: Ist das Holz morsch? Sind die Anweisungen klar? Die Forscher überprüften die „Gesundheit“ dieser Templates, indem sie nach Bugs, Sicherheitslücken und unordentlichem Code (Code Smells) suchten.
- Die „verzerrte“ Realität: Die meisten Templates sind eigentlich recht sauber. Eine riesige Anzahl von ihnen weist null schwerwiegende Probleme auf. Es gibt jedoch einige wenige, die in einem schrecklichen Zustand sind und den Durchschnitt nach unten ziehen. Es ist wie ein Geschäft, in dem 90 % der Kits perfekt sind, aber 10 % völlig zerfallen.
- Keine „Einheitsgröße“-Regel: Man kann nicht davon ausgehen, dass ein Kit gut ist, nur weil es viele Sterne (Likes) oder Forks hat.
- Bei JavaScript bedeutete das viele Forken tatsächlich mehr Bugs (vielleicht, weil Leute unordentlichen Code kopierten).
- Bei Python bedeutete das viele Forken weniger Bugs.
- Die Lektion: Die Popularität eines Templates bedeutet nicht automatisch hohe Qualität. Man muss genauer hinschauen.
- Wer macht einen Unterschied? Kits, die von Organisationen (Unternehmen) erstellt wurden, tendieren dazu, etwas sauberer zu sein als die von Einzelpersonen, aber der Unterschied ist gering. Die verwendete Sprache spielt eine größere Rolle als der Ersteller.
3. Wie baut und nutzt man bessere Kits (Leitlinien & Fallstricke)
Die Forscher haben nicht nur Bugs gezählt; sie haben die besten und schlechtesten Kits untersucht, um herauszufinden, was ein Template erfolgreich macht.
Gute Gewohnheiten (Leitlinien):
- Alles automatisieren: Die besten Kits kommen mit „Robotern“ (Automatisierungstools), die Fehler prüfen und Teile automatisch aktualisieren.
- Ein großartiges Handbuch schreiben: Ein Kit ist nutzlos, wenn man nicht weiß, wie man es zusammenbaut. Die besten Templates haben klare, schrittweise Anleitungen und nicht nur eine Liste von Dateien.
- Den richtigen Knopf benutzen: Viele Templates sagen den Nutzern, sie sollen das Repo „klonen“ (die ganze Sache kopieren). Die Forscher sagen: Tun Sie das nicht! Nutzen Sie den spezifischen „Use this template“-Button auf GitHub, der eine frische, saubere Kopie ohne die Historie des Originals erstellt.
- Versionen synchron halten: Wenn das Kit eine bestimmte Version eines Werkzeugs verwendet (wie eine spezifische Engine für ein Spiel), sollte das Template klar angeben, welche Version es unterstützt, damit Sie nicht ein Haus mit den falschen Ziegeln bauen.
Schlechte Gewohnheiten (Fallstricke):
- Das „Fake“-Template: Manche Leute nehmen eine fertige, komplexe Anwendung und kleben einfach ein „Template“-Etikett darauf. Das ist so, als würde man ein voll möbliertes, bewohntes Haus als „Starter-Kit“ verkaufen. Es ist verwirrend und schwer zu nutzen.
- Die Geisterstadt: Einige Templates sind verlassen. Die Ersteller haben aufgehört, sie zu aktualisieren, aber sie haben sie nicht als „archiviert“ oder „inaktiv“ markiert. Das täuscht Nutzer dazu, auf einem Fundament aufzubauen, das gerade zerbröckelt.
- Der Mix aus allem: Templates für fünf verschiedene Sprachen in einem einzigen Ordner zu sammeln, ist unordentlich. Es ist, als würde man Blaupausen für ein Boot, ein Auto und ein Haus in dieselbe Kiste legen. Es ist besser, separate, klare Kits für jede Sprache zu haben.
Das Fazit
Diese Studie ist ein Weckruf für jeden, der diese Starter-Kits nutzt oder erstellt.
- Für Nutzer: Greifen Sie nicht einfach zum populärsten Template. Prüfen Sie, ob es tatsächlich gepflegt wird, ob die Dokumentation klar ist und ob es Ihren spezifischen Bedürfnissen entspricht.
- Für Ersteller: Wenn Sie ein Template erstellen, behandeln Sie es wie ein Produkt. Halten Sie es aktuell, schreiben Sie gute Anleitungen und stellen Sie sicher, dass es tatsächlich darauf ausgelegt ist, wiederverwendet zu werden, und nicht nur kopiert zu werden.
Die Forscher merkten auch an, dass diese Templates, da sie erst 2019 eingeführt wurden, noch sehr neu sind und wir gerade erst anfangen zu verstehen, wie sie die Welt der Software prägen. Sie sind mächtige Werkzeuge, die das Bauen von Software beschleunigen können, aber nur, wenn sie korrekt gebaut und genutzt werden.
Ertrinken Sie in Arbeiten in Ihrem Fachgebiet?
Erhalten Sie tägliche Digests der neuesten Arbeiten passend zu Ihren Forschungsbegriffen — mit technischen Zusammenfassungen, in Ihrer Sprache.