Willkommen bei Cat Docs - Ein Open -Source -Projekt, das Katzen dokumentiert!
Die Idee dieses Projekts ist es, alle Informationen zu Katzen zu einer Website zu kombinieren - sei es um Tipps für den Besitz einer Katze als Haustier, lernte Katzengeschichte, alle Katzenprodukte, wie Sie es nennen.
Fühlen Sie sich frei, um einen Beitrag zu leisten und neue Probleme für Feedback oder Fragen zu erstellen, die Sie haben! Dies ist ein Projekt über alles und alles, was mit Katzen zu tun hat. Sie können gerne erkunden!
Für Anfänger
- Fühlen Sie sich frei, neue Probleme zu eröffnen und vorhanden zu kommentieren, wenn Sie Aufgaben übernehmen möchten. Hilfe ist immer willkommen!
Danke, dass du Katzendokumente besuchst!
? Beitragsrichtlinien:
Erste Schritte
Richten Sie das Projekt lokal ein, indem Sie folgende Schritte befolgen:
Fork das Repository :
- Klicken Sie in der oberen rechten Ecke der Repository-Seite auf die Schaltfläche "Fork", um eine Kopie des Repositorys unter Ihrem eigenen Github-Konto zu erstellen.
Klonen Sie Ihre Gabel :
- Klonen Sie das Forked Repository mit dem folgenden Befehl in Ihren lokalen Computer:
git clone https://github.com/your-username/cat-docs.git
your-username durch Ihren Github-Benutzernamen.
Navigieren Sie zum Projektverzeichnis :
Abhängigkeiten installieren :
- Installieren Sie die erforderlichen Abhängigkeiten mit dem Paketmanager Ihrer Wahl. Zum Beispiel mit NPM:
Führen Sie das Projekt aus :
- Starten Sie das Projekt mit dem Befehl vitpress, um sicherzustellen, dass alles korrekt funktioniert:
Beitragen
Durchsuchen Sie die Probleme :
- Schauen Sie sich die Probleme an, um eine zu finden, die Sie interessiert. Kommentieren Sie das Problem, damit die Betreuer wissen, dass Sie daran arbeiten möchten. Das Problem wird Ihnen dann zugewiesen.
Erstellen Sie einen Zweig :
- Erstellen Sie eine neue Filiale für Ihre Arbeit. Verwenden Sie einen beschreibenden Namen, der sich auf das Problem bezieht, das Sie angehen. Zum Beispiel:
git checkout -b issue-123-add-cat-facts
Nehmen Sie Ihre Änderungen vor :
- Implementieren Sie Ihre Änderungen und verpflichten Sie sie in Ihrer Niederlassung. Befolgen Sie die Codierungsstandards des Projekts und begehen Sie Nachrichtenrichtlinien.
Drücken Sie Ihren Zweig :
- Schieben Sie Ihren Zweig zu Ihrem Gabel -Repository:
git push origin issue-123-add-cat-facts
Senden Sie eine Pull -Anfrage (PR) :
- Gehen Sie zum ursprünglichen Repository in GitHub und Sie sollten eine Aufforderung zum Erstellen einer Pull -Anfrage sehen. Klicken Sie auf "Vergleiche und ziehen Sie die Anfrage".
PR -Überprüfung und Genehmigung :
- Ihre Pull -Anfrage wird von den Betreuern überprüft. Bitte seien Sie geduldig und reagieren Sie auf alle Feedback, die Sie erhalten. Nur die Betreuer haben die Befugnis, Ihre Änderungen zusammenzuführen und einzusetzen.
Erfahren Sie mehr
Ausführlichere Informationen über die Arbeit mit Gabeln und den Beitrag zu Open-Source-Projekten finden Sie in Githubs Leitfaden zur Arbeit mit Gabeln.
