Hey beginners,
herzlichen Glückwunsch zu deinem Weg zu open source. Es ist eine tolle Gemeinschaft.
Am Anfang ist es etwas verwirrend. Wie zu tragen, in denen dazu beitragen, Probleme, bugs, PR, PR, PR!
Keine Sorge, wenn Sie sich in Open Source engagieren, werden Sie alles lernen.
Aber heute möchte ich Ihnen einige Ratschläge geben, die ich zu Beginn meiner Open-Source-Reise nie erhalten habe.
Ich habe vor einiger Zeit angefangen, zu Open Source beizutragen und alle meine kleinen Nebenprojekte auf GitHub zu setzen., Damals wusste ich nichts über den README-Teil. Die Zeit verging und ich fing an, einigen Kickass-Entwicklern zu folgen. Zweifellos hatten sie alle erstaunliche Projekte, aber das Häufigste war, dass alle ihre Projekte eine großartige README hatten und so lernte ich die Bedeutung einer guten README kennen.
STOPP!! Ich bin nicht daran interessiert, über Ihre Open-Source-Reise zu lesen. Erzähl mir einfach, wie man eine gute README schreibt.
Cool. Also hier gehts –
Bevor Sie anfangen, Ihre großartigen Projekte auf GitHub zu setzen, möchte ich, dass Sie zuerst über Readme Driven Development lesen.,
Warum sollte ich mich um eine README kümmern?
Open-source-community wächst rasant. Entwickler veröffentlichen täglich neue Open-Source-Projekte auf GitHub. Infolgedessen wird es immer schwieriger, Ihr eigenes Projekt vom Meer der Open-Source-Software abzuheben. Sie können jedoch einige Dinge tun, um Ihre Chancen zu erhöhen, die Aufmerksamkeit anderer Entwickler zu erregen. Eine effektive und einfache Technik ist das Aufstellen einer gut aussehenden und hilfreichen README-Datei.
Ihre README sollte so gut wie Ihr Projekt sein., Eine großartige README-Datei hilft Ihrem Projekt, sich vom Meer der Open-Source-Software auf GitHub abzuheben.
Eine README ist wie das Gesicht Ihres Projekts. Es ist die erste Datei, die eine Person lesen sollte, wenn sie auf einen Quellbaum stößt, und sie sollte als sehr kurze und sehr grundlegende Einführung in die Software geschrieben werden.
Ein Projekt ohne README ist nicht so nützlich. Schauen wir uns zum Beispiel dieses Projekt an.
Keine README, keine beschreibung, keine nichts. Du wirst keine Ahnung bekommen, was dieser Kerl gebaut hat, egal wie großartig es ist.,
Schauen wir uns nun dieses Projekt an. Der Autor hat detaillierte und klare Anweisungen zum Projekt erwähnt und damit für andere einfacher zu bedienen und auszuprobieren.
Eine schöne README ist eine gute Möglichkeit, Menschen zu helfen, sich auch an dem Projekt zu beteiligen. Ein Projekt mit schöner README und Screenshots wird die Aufmerksamkeit der Benutzer besser auf sich ziehen, da es eine direkte Möglichkeit ist zu erklären, warum dieses Projekt wichtig ist und warum Menschen das Projekt nutzen und dazu beitragen sollten. Eine gute README sollte auch genügend Details enthalten, um einem neuen Benutzer den Einstieg zu erleichtern, z, wie zu kompilieren, wie zu installieren, und wie die Integration zu starten.
Ok. Genug geredet. Zeig mir dann, wie man eine gute README schreibt.
Jetzt, da Sie zustimmen, dass README wichtig ist, werde ich Ihnen sagen, wie man einen schreibt. Es ist nicht so schwierig. Sie müssen nur mit einigen Aufzählungspunkten bleiben. Hier sind einige der Punkte, die Sie beim Schreiben einer README beachten sollten.
die Formatierung der README?,
Nachdem Sie sich nun beigebracht haben, wie und was Sie in eine README schreiben sollen, lassen Sie uns ein wenig über das Styling von README aka Formatierung sprechen.
Die Formatierung ist ein wesentlicher Bestandteil von README. Hier und hier erfahren Sie, wie Sie Ihre README formatieren.
Denken Sie am Ende daran —
Sie müssen keine vollständige Readme-gesteuerte Entwicklung durchführen, Sie müssen nicht alle diese Aufzählungszeichen einschließen, Sie müssen keinem bestimmten Prozess folgen. Aber das Schreiben einer guten README wird definitiv Ihre Dokumentationsfähigkeiten verbessern, was Sie zu einem besseren Entwickler macht.,
Leave a Reply