Willkommen! ??
Good First Issue ist eine Initiative zur Zusammenstellung einfacher Auszüge aus beliebten Projekten, damit Entwickler, die noch nie zu Open Source beigetragen haben, schnell loslegen können.
Open-Source-Betreuer sind immer auf der Suche nach mehr Leuten, die sich engagieren, aber neue Entwickler halten es im Allgemeinen für schwierig, Mitwirkende zu werden. Wir glauben, dass die Hürde für zukünftige Beiträge beseitigt wird, wenn man Entwickler dazu bringt, supereinfache Probleme zu beheben. Aus diesem Grund gibt es Good First Issue.
Sie können gerne ein neues Projekt in Good First Issue hinzufügen, und wir ermutigen alle Projekte – alte und neue, große und kleine.
Befolgen Sie diese einfachen Schritte:
Unser Ziel ist es, Projekte für neue Open-Source-Mitwirkende einzugrenzen. Um die Qualität der Projekte in Good First Issue aufrechtzuerhalten, stellen Sie bitte sicher, dass Ihr GitHub-Repository die folgenden Kriterien erfüllt:
Es gibt mindestens drei Ausgaben mit dem good first issue . Dieses Label ist standardmäßig bereits in allen Repositorys vorhanden. Wenn nicht, können Sie die Schritte hier befolgen.
Es hat mindestens 10 Mitwirkende.
Es enthält eine README.md mit detaillierten Einrichtungsanweisungen für das Projekt und eine CONTRIBUTING.md mit Richtlinien für neue Mitwirkende.
Es wird aktiv gepflegt.
Fügen Sie den Pfad Ihres Repositorys (in lexikografischer Reihenfolge) in data/repositories.toml hinzu.
Erstellen Sie eine neue Pull-Anfrage. Bitte fügen Sie den Link zur Problemseite des Repositorys in der PR-Beschreibung hinzu. Sobald die Pull-Anfrage zusammengeführt ist, werden die Änderungen auf goodfirstissue.dev live sein.
Good First Issue besteht aus zwei Komponenten – der mit Nuxt.js erstellten Front-End-App und einem in Python geschriebenen Datenpopulationsskript.
Um neue Funktionen und Änderungen zur Website beizutragen, möchten Sie die App lokal ausführen. Bitte folgen Sie diesen Schritten:
Klonen Sie das Projekt lokal. Stellen Sie sicher, dass auf Ihrem Computer Python 3 und eine aktuelle Version von Node.js installiert sind.
Erstellen Sie eine Kopie der Beispieldatendateien, damit Ihre lokale App sie verwenden kann, und benennen Sie sie in den Dateinamen um, den die App erwartet. Dieser Schritt ist wichtig, da die Frontend-App ohne diese Datendateien nicht funktioniert.
$ cp data/generated.sample.json data/generated.json $ cp data/tags.sample.json data/tags.json
Erstellen Sie die Front-End-App und starten Sie den Entwicklungsserver.
$ bun install # die Abhängigkeiten installieren$ bun dev # den Entwicklungsserver starten
Die App sollte in Ihrem Browser geöffnet werden.
