cryptoadvocate/cryptohackappDie mobile Engineering-Heimat des Cryptohack Badge-Projekts.
Um Ihnen den Einstieg in GitLab zu erleichtern, finden Sie hier eine Liste empfohlener nächster Schritte.
Bereits ein Profi? Bearbeiten Sie einfach diese README.md und machen Sie sie zu Ihrer eigenen. Möchten Sie es einfach haben? Nutzen Sie die Vorlage unten!
cd existing_repo
git remote add origin https://gitlab.com/cryptoadvocate/cryptohackapp.git
git branch -M main
git push -uf origin main
Nutzen Sie die integrierte kontinuierliche Integration in GitLab.
Wenn Sie bereit sind, diese README zu Ihrer eigenen zu machen, bearbeiten Sie einfach diese Datei und nutzen Sie die praktische Vorlage unten (oder Sie können sie strukturieren, wie Sie möchten – dies ist nur ein Ausgangspunkt!). Danke an makeareadme.com für diese Vorlage.
Jedes Projekt ist anders, überlegen Sie daher, welche dieser Abschnitte auf Ihr Projekt zutreffen. Die in der Vorlage verwendeten Abschnitte sind Vorschläge für die meisten Open-Source-Projekte. Denken Sie auch daran, dass eine README zwar zu lang und detailliert sein kann, aber zu lang ist besser als zu kurz. Wenn Sie denken, dass Ihre README zu lang ist, ziehen Sie in Betracht, eine andere Form der Dokumentation zu verwenden, anstatt Informationen herauszuschneiden.
Wählen Sie einen selbsterklärenden Namen für Ihr Projekt.
Lassen Sie die Leute wissen, was Ihr Projekt genau kann. Geben Sie Kontext und fügen Sie einen Link zu einer Referenz hinzu, die Besuchern möglicherweise unbekannt ist. Eine Liste von Funktionen oder ein Hintergrund-Abschnitt können hier ebenfalls hinzugefügt werden. Wenn es Alternativen zu Ihrem Projekt gibt, ist dies ein guter Ort, um Unterscheidungsmerkmale aufzulisten.
In manchen READMEs sehen Sie möglicherweise kleine Bilder, die Metadaten vermitteln, wie zum Beispiel, ob alle Tests für das Projekt bestanden werden. Sie können Shields verwenden, um einige zu Ihrer README hinzuzufügen. Viele Dienste haben auch Anweisungen zum Hinzufügen eines Badges.
Je nachdem, was Sie erstellen, kann es eine gute Idee sein, Screenshots oder sogar ein Video einzufügen (Sie werden häufig GIFs statt tatsächlicher Videos sehen). Tools wie ttygif können helfen, aber schauen Sie sich Asciinema für eine ausgefeiltere Methode an.
Innerhalb eines bestimmten Ökosystems gibt es möglicherweise eine übliche Methode zum Installieren von Dingen, wie die Verwendung von Yarn, NuGet oder Homebrew. Bedenken Sie jedoch die Möglichkeit, dass die Person, die Ihre README liest, ein Neuling ist und mehr Anleitung wünscht. Das Auflisten spezifischer Schritte hilft, Unklarheiten zu beseitigen und bringt die Leute so schnell wie möglich dazu, Ihr Projekt zu nutzen. Wenn es nur in einem bestimmten Kontext läuft, z.B. einer bestimmten Programmiersprachenversion oder einem Betriebssystem, oder Abhängigkeiten hat, die manuell installiert werden müssen, fügen Sie auch einen Abschnitt „Voraussetzungen“ hinzu.
Verwenden Sie Beispiele großzügig und zeigen Sie die erwartete Ausgabe, wenn möglich. Es ist hilfreich, das kleinste Beispiel der Verwendung direkt einzubinden, das Sie demonstrieren können, während Sie Links zu ausgefeilteren Beispielen bereitstellen, wenn diese zu lang sind, um sie vernünftigerweise in die README aufzunehmen.
Sagen Sie den Leuten, wo sie Hilfe bekommen können. Es kann jede Kombination aus einem Issue-Tracker, einem Chat-Raum, einer E-Mail-Adresse usw. sein.
Wenn Sie Ideen für zukünftige Versionen haben, ist es eine gute Idee, diese in der README aufzulisten.
Geben Sie an, ob Sie offen für Beiträge sind und welche Anforderungen Sie an deren Annahme stellen.
Für Personen, die Änderungen an Ihrem Projekt vornehmen möchten, ist es hilfreich, eine Dokumentation zum Einstieg zu haben. Vielleicht gibt es ein Skript, das sie ausführen sollten, oder einige Umgebungsvariablen, die sie setzen müssen. Machen Sie diese Schritte explizit. Diese Anweisungen könnten auch für Ihr zukünftiges Ich nützlich sein.
Sie können auch Befehle zum Linten des Codes oder zum Ausführen von Tests dokumentieren. Diese Schritte helfen, eine hohe Codequalität sicherzustellen und die Wahrscheinlichkeit zu verringern, dass die Änderungen versehentlich etwas kaputt machen. Anweisungen zum Ausführen von Tests sind besonders hilfreich, wenn eine externe Einrichtung erforderlich ist, wie das Starten eines Selenium-Servers zum Testen in einem Browser.
Zeigen Sie Ihre Wertschätzung für diejenigen, die zum Projekt beigetragen haben.
Für Open-Source-Projekte geben Sie an, wie es lizenziert ist.
Wenn Ihnen die Energie oder die Zeit für Ihr Projekt ausgegangen ist, fügen Sie oben in der README einen Hinweis ein, dass die Entwicklung verlangsamt oder ganz eingestellt wurde. Jemand könnte sich entscheiden, Ihr Projekt zu forken oder sich freiwillig als Maintainer oder Eigentümer zu melden, damit Ihr Projekt weitergeführt werden kann. Sie können auch explizit nach Maintainern suchen.