
Magento-/Adobe-Commerce-Installationen über composer.lock scannen – CVE-Abgleich über die ValtersIT-API
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 sich einfach machen? Verwenden Sie die Vorlage am Ende!
cd existing_repo
git remote add origin https://gitlab.com/valtersit/magento-cve-scanner.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 ganz nach Ihren Wünschen – dies ist nur ein Ausgangspunkt!). Danke an makeareadme.com für diese Vorlage.
Jedes Projekt ist anders, daher sollten Sie überlegen, 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 außerdem: Eine README kann zwar zu lang und detailliert sein, aber zu lang ist besser als zu kurz. Wenn Sie der Meinung sind, dass Ihre README zu lang ist, ziehen Sie in Betracht, eine andere Form der Dokumentation zu nutzen, anstatt Informationen wegzulassen.
Wählen Sie einen selbsterklärenden Namen für Ihr Projekt.
Lassen Sie die Leute wissen, was Ihr Projekt konkret leisten kann. Geben Sie Kontext und fügen Sie einen Link zu jeder Referenz hinzu, mit der Besucher möglicherweise nicht vertraut sind. Eine Liste von Funktionen oder ein Unterabschnitt „Hintergrund“ kann 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 kleine Bilder, die Metadaten vermitteln, etwa ob alle Tests für das Projekt erfolgreich sind. Sie können Shields verwenden, um einige zu Ihrer README hinzuzufügen. Viele Dienste bieten auch Anleitungen zum Hinzufügen eines Badges.
Je nachdem, was Sie erstellen, kann es eine gute Idee sein, Screenshots oder sogar ein Video einzubinden (häufig sieht man GIFs statt echter Videos). 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 gängige Art der Installation, etwa mit Yarn, NuGet oder Homebrew. Bedenken Sie jedoch, dass derjenige, der Ihre README liest, ein Neuling sein könnte und sich mehr Anleitung wünscht. Das Auflisten konkreter 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, etwa einer bestimmten Programmiersprachenversion oder einem Betriebssystem, oder Abhängigkeiten hat, die manuell installiert werden müssen, fügen Sie auch einen Unterabschnitt „Voraussetzungen“ hinzu.
Verwenden Sie großzügig Beispiele und zeigen Sie nach Möglichkeit die erwartete Ausgabe. Es ist hilfreich, das kleinste Beispiel für die Verwendung, das Sie demonstrieren können, inline zu haben, während Sie Links zu ausgefeilteren Beispielen bereitstellen, wenn diese zu lang sind, um sie sinnvoll in die README aufzunehmen.
Teilen Sie den Leuten mit, wohin sie sich für Hilfe wenden können. Das kann jede Kombination aus einem Issue-Tracker, einem Chatraum, einer E-Mail-Adresse usw. sein.
Wenn Sie Ideen für zukünftige Releases haben, ist es eine gute Idee, diese in der README aufzulisten.
Geben Sie an, ob Sie für Beiträge offen sind und welche Anforderungen Sie für deren Annahme haben.
Für Personen, die Änderungen an Ihrem Projekt vornehmen möchten, ist es hilfreich, eine gewisse Dokumentation darüber zu haben, wie man loslegt. 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 dafür eine externe Einrichtung erforderlich ist, etwa das Starten eines Selenium-Servers zum Testen in einem Browser.
Zeigen Sie Ihre Wertschätzung für diejenigen, die zum Projekt beigetragen haben.
Geben Sie bei Open-Source-Projekten an, wie das Projekt lizenziert ist.
Wenn Ihnen die Energie oder die Zeit für Ihr Projekt ausgegangen ist, fügen Sie oben im README einen Hinweis hinzu, dass die Entwicklung sich verlangsamt hat oder vollständig eingestellt wurde. Jemand könnte sich entscheiden, Ihr Projekt zu forken oder sich freiwillig als Maintainer oder Eigentümer einzubringen, sodass Ihr Projekt weiterbestehen kann. Sie können auch ausdrücklich um Maintainer bitten.