verto

Verto.sh

Ihr Tor zur Open-Source-Zusammenarbeit.

---

Treten Sie mit Verto.sh in die Welt der Open-Source! Wir wählen sorgfältig beliebte Projekte mit leicht zu tackenden Problemen aus, um es den Entwicklern einfach zu machen, ein neues oder erstes Projekt zu finden, zu dem sie beigetragen haben. Verto.sh ist mehr als nur eine Liste - es ist eine Plattform. Hier können Anfänger ihren ersten Beitrag leisten, Gründer können ein solides Team aufbauen und die Betreuer können neue Mitwirkende finden.

Die Open-Source-Community begrüßt immer neue Talente, aber der Einstieg kann sich hart anfühlen. Verto.sh macht es einfacher. Indem wir Neuankömmlingen die Seile zeigen und sie mit Projekten verbinden, die eine Hand benötigen, helfen wir nicht nur Einzelpersonen, sondern auch die gesamte Open-Source-Bewegung.

Machen Sie mit Verto.sh den ersten Schritt in die kollaborative Codierung und seien Sie Teil von etwas Größerem. Ihr heutiger Code könnte der Beginn von etwas Erstaunlichem in der Open-Source-Community sein.

Hinzufügen eines neuen Projekts

Sie können ein neues Projekt in verto.sh hinzuzufügen, und befolgen Sie einfach die folgenden Schritte:

• Um die Qualität von Projekten in Verto.sh zu erhalten, stellen Sie bitte sicher, dass das Repository, das Sie hinzufügen möchten, die folgenden Kriterien erfüllt:

  • Für GitHub -Repositories: Es hat mindestens drei Probleme mit dem good first issue oder anderen in config.json definierten Beschriftungen (siehe labels und Ende des GitHub -Anbieters).

  • Für GitLab -Repositories: Es gibt mindestens drei Probleme mit dem quick win -Etikett oder anderen in config.json definierten Labels (siehe labels und das Ende des GitLab -Anbieters).

  • Es hat mindestens 10 Mitwirkende.

  • Es hat mindestens 1000 Sterne.

  • Es enthält eine Readme.md mit detaillierten Setup -Anweisungen für das Projekt und einen Beitrag.

  • Es wird aktiv gepflegt (letzter Update vor weniger als 1 Monat).

• Für GitHub -Repositories: Fügen Sie den Pfad Ihres Repositorys (im Formatinhaber owner/name und lexikografische Reihenfolge) zu Config.json im GitHub -Anbieter hinzu.

• Für GitLab -Repositories: Fügen Sie die ID Ihres Repositorys (im Format <project path>|<project id> ) zu config.json im GitLab -Anbieter hinzu.

• Erstellen Sie eine neue Pull-Request. Bitte fügen Sie den Link zu der Ausgabenseite des Repositorys in der PR -Beschreibung hinzu. Sobald die Pull -Anfrage verschmolzen ist, werden die Änderungen auf Verto.sh live sein.

Wie funktioniert es?

Verto.sh verwendet Next.js, React und TypeScript. Die auf der Website gezeigten Daten werden aus der Datei data.json geladen, die von einer Funktion in Data/utils.ts generiert wird. Es fragt die Github- und GitLab -APIs ab, um Probleme aus den in config.json aufgeführten Repositorys abzuholen. Die in config.json definierten Beschriftungen werden verwendet, um Probleme für die Repositorys zu filtern.

So richten Sie das Projekt lokal ein

Um neue Funktionen und Änderungen auf der Website beizutragen, möchten Sie die App lokal ausführen. Bitte befolgen Sie diese Schritte:

1. Geben Sie das Repository aus, klonen Sie es lokal, erstellen Sie einen neuen Zweig, um an einer bestimmten Funktion oder einem Fehlerfix zu arbeiten, ohne den Hauptzweig des Repositorys zu beeinflussen. Stellen Sie sicher, dass Sie eine aktuelle Version von Node.js auf Ihrem Computer installiert haben.
2. Sie können die mitgelieferten Data.json als Dummy -Daten verwenden oder npm run prebuild um die neuesten Daten von GitHub selbst zu holen: dafür müssen Sie die GH_PAT -Umgebungsvariable auf einen gültigen GitHub Personal Access Token (PAT) festlegen. Hinweis: Repositories, die die oben aufgeführten Kriterien nicht mach machen (siehe Regeln in Data.jsonare, automatisch von config.json entfernt, wenn das Skript [data.json] data/data.json) ausgeführt wird.
3. Starten Sie den Entwicklungsserver und öffnen Sie die App in Ihrem Browser.

 # install the dependencies
$ npm install
# start the development server
$ npm run dev

Gut zu wissen, wenn Sie sich verpflichten: Das Projekt enthält einen pre-commit Hook, in dem Linter automatisch ausgeführt werden, um die Codequalität zu gewährleisten!