zzugab/juice-shop-with-kubeadm-and-tfAutomatisierte Bereitstellung von OWASP Juice Shop auf Kubernetes mit kubeadm und Terraform, mit integriertem Trivy-Schwachstellenscan für DevSecOps-Pipelines.
Um 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? Verwenden Sie die Vorlage unten!
cd existing_repo
git remote add origin https://gitlab.com/zzugab/juice-shop-with-kubeadm-and-tf.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 verwenden Sie die praktische Vorlage unten (oder strukturieren Sie sie nach Belieben – dies ist nur ein Ausgangspunkt!). Danke an makeareadme.com für diese Vorlage.
Jedes Projekt ist anders, überlegen Sie also, welche dieser Abschnitte auf Ihr Projekt zutreffen. Die in der Vorlage verwendeten Abschnitte sind Vorschläge für die meisten Open-Source-Projekte. Bedenken Sie auch, dass eine README zwar zu lang und detailliert sein kann, aber zu lang ist besser als zu kurz. Wenn Sie glauben, dass Ihre README zu lang ist, ziehen Sie eine andere Form der Dokumentation in Betracht, anstatt Informationen wegzulassen.
Wählen Sie einen selbsterklärenden Namen für Ihr Projekt.
Teilen Sie mit, was Ihr Projekt im Speziellen kann. Geben Sie Kontext und fügen Sie einen Link zu einer Referenz hinzu, die Besuchern möglicherweise nicht vertraut ist. Hier kann auch eine Liste von Funktionen oder ein Unterabschnitt „Hintergrund“ hinzugefügt werden. Falls es Alternativen zu Ihrem Projekt gibt, ist dies ein guter Ort, um die Unterscheidungsmerkmale aufzulisten.
In manchen READMEs sehen Sie kleine Bilder, die Metadaten übermitteln, z. B. ob alle Tests für das Projekt bestanden werden. Sie können Shields verwenden, um solche 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 anstelle von echten Videos sehen). Tools wie ttygif können helfen, aber schauen Sie sich Asciinema für eine anspruchsvollere Methode an.
In einem bestimmten Ökosystem gibt es möglicherweise eine übliche Art, Dinge zu installieren, z. B. mit Yarn, NuGet oder Homebrew. Bedenken Sie jedoch, dass der Leser Ihrer README möglicherweise ein Neuling ist und mehr Anleitung wünscht. Die Auflistung konkreter Schritte hilft, Unklarheiten zu beseitigen, und ermöglicht es den Leuten, Ihr Projekt so schnell wie möglich zu nutzen. Wenn es nur in einem bestimmten Kontext läuft, wie einer bestimmten Programmiersprachenversion oder einem bestimmten Betriebssystem, oder Abhängigkeiten hat, die manuell installiert werden müssen, fügen Sie auch einen Unterabschnitt „Anforderungen“ hinzu.
Verwenden Sie großzügig Beispiele und zeigen Sie nach Möglichkeit die erwartete Ausgabe. Es ist hilfreich, das kleinste anwendbare Beispiel inline zu haben, während Sie Links zu komplexeren Beispielen bereitstellen, wenn diese zu lang sind, um sie in die README aufzunehmen.
Teilen Sie mit, wohin sich Benutzer für Hilfe wenden können. Dies kann eine beliebige Kombination aus Issue-Tracker, Chatroom, 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 zu haben, wie sie beginnen können. Vielleicht gibt es ein Skript, das sie ausführen sollen, 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 dies eine externe Einrichtung erfordert, wie z. B. das Starten eines Selenium-Servers zum Testen in einem Browser.
Zeigen Sie Ihre Wertschätzung gegenüber denen, die zum Projekt beigetragen haben.
Geben Sie für Open-Source-Projekte an, wie es lizenziert ist.
Wenn Ihnen die Energie oder Zeit für Ihr Projekt ausgegangen ist, fügen Sie oben in der README einen Hinweis ein, dass die Entwicklung verlangsamt oder vollständig 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.