valtersit/wordpress-cve-scannerDurchsuchen Sie Ihren WordPress-Core, Ihre Themes und Plugins über die Kommandozeile nach bekannten CVEs. Open Source, überprüfbar, datenschutzorientiert — unterstützt durch die ValtersIT CVE API.
Um dir den Einstieg in GitLab zu erleichtern, findest du hier eine Liste empfohlener nächster Schritte.
Schon ein Profi? Dann bearbeite einfach diese README.md und mach sie zu deiner eigenen. Möchtest du es dir leicht machen? Nutze die Vorlage am Ende!
cd existing_repo
git remote add origin https://gitlab.com/valtersit/wordpress-cve-scanner.git
git branch -M main
git push -uf origin main
Nutze die integrierte kontinuierliche Integration in GitLab.
Wenn du bereit bist, diese README zu deiner eigenen zu machen, bearbeite einfach diese Datei und nutze die praktische Vorlage unten (oder strukturiere sie ganz nach deinen Wünschen - dies ist nur ein Ausgangspunkt!). Danke an makeareadme.com für diese Vorlage.
Jedes Projekt ist anders, also überlege, welche dieser Abschnitte auf deines zutreffen. Die in der Vorlage verwendeten Abschnitte sind Vorschläge für die meisten Open-Source-Projekte. Bedenke auch, dass eine README zwar zu lang und detailliert sein kann, aber zu lang besser ist als zu kurz. Wenn du denkst, dass deine README zu lang ist, ziehe in Betracht, eine andere Form der Dokumentation zu nutzen, anstatt Informationen zu streichen.
Wähle einen selbsterklärenden Namen für dein Projekt.
Lass die Leute wissen, was dein Projekt konkret leisten kann. Gib Kontext und füge einen Link zu jeder Referenz hinzu, mit der Besucher möglicherweise nicht vertraut sind. Eine Liste von Features oder ein Unterabschnitt zum Hintergrund kann hier ebenfalls hinzugefügt werden. Wenn es Alternativen zu deinem Projekt gibt, ist dies ein guter Ort, um Unterscheidungsmerkmale aufzulisten.
In manchen READMEs siehst du möglicherweise kleine Bilder, die Metadaten vermitteln, z. B. ob alle Tests für das Projekt bestanden werden. Du kannst Shields verwenden, um einige zu deiner README hinzuzufügen. Viele Dienste haben auch Anleitungen zum Hinzufügen eines Badges.
Je nachdem, was du erstellst, kann es eine gute Idee sein, Screenshots oder sogar ein Video einzufügen (du wirst häufig GIFs anstelle von tatsächlichen Videos sehen). Tools wie ttygif können helfen, aber schau dir Asciinema für eine ausgefeiltere Methode an.
Innerhalb eines bestimmten Ökosystems gibt es möglicherweise eine gängige Art, Dinge zu installieren, z. B. mit Yarn, NuGet oder Homebrew. Bedenke jedoch die Möglichkeit, dass derjenige, der deine README liest, ein Anfänger ist und mehr Anleitung wünscht. Das Auflisten konkreter Schritte hilft, Mehrdeutigkeiten zu beseitigen, und bringt die Leute dazu, dein Projekt so schnell wie möglich zu nutzen. Wenn es nur in einem bestimmten Kontext läuft, wie einer bestimmten Programmiersprachenversion oder einem Betriebssystem, oder Abhängigkeiten hat, die manuell installiert werden müssen, füge auch einen Unterabschnitt zu den Anforderungen hinzu.
Verwende großzügig Beispiele und zeige nach Möglichkeit die erwartete Ausgabe. Es ist hilfreich, das kleinste Beispiel für die Verwendung, das du demonstrieren kannst, inline zu haben, während du Links zu komplexeren Beispielen bereitstellst, wenn diese zu lang sind, um sie vernünftigerweise in die README aufzunehmen.
Sag den Leuten, wohin sie sich für Hilfe wenden können. Es kann jede Kombination aus einem Issue-Tracker, einem Chatraum, einer E-Mail-Adresse usw. sein.
Wenn du Ideen für zukünftige Releases hast, ist es eine gute Idee, sie in der README aufzulisten.
Gib an, ob du für Beiträge offen bist und welche Anforderungen du für deren Annahme hast.
Für Leute, die Änderungen an deinem Projekt vornehmen möchten, ist es hilfreich, eine gewisse Dokumentation zum Einstieg zu haben. Vielleicht gibt es ein Skript, das sie ausführen sollten, oder einige Umgebungsvariablen, die sie setzen müssen. Mach diese Schritte explizit. Diese Anweisungen könnten auch für dein zukünftiges Ich nützlich sein.
Du kannst 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 sie eine externe Einrichtung erfordern, wie das Starten eines Selenium-Servers zum Testen in einem Browser.
Zeige deine Wertschätzung für diejenigen, die zum Projekt beigetragen haben.
Bei Open-Source-Projekten gib an, wie sie lizenziert sind.
Wenn dir die Energie oder Zeit für dein Projekt ausgegangen ist, füge oben in der README einen Hinweis ein, dass die Entwicklung sich verlangsamt hat oder vollständig eingestellt wurde. Jemand könnte sich entscheiden, dein Projekt zu forken oder sich als Maintainer oder Eigentümer freiwillig zu melden, wodurch dein Projekt weiterlaufen kann. Du kannst auch explizit um Maintainer bitten.