juice-shop/juice-shop: Redaktioneller README-Leitfaden

juice-shop/juice-shop beschreibt sich im README als „OWASP Juice Shop: Probably the most modern and sophisticated insecure web application". Dieser Text bleibt bei Fakten, die im Repository überprüfbar sind. Sterne, Forks und Badges zeigen Aufmerksamkeit, aber keine Qualität. Unter „OWASP Juice Shop" steht: > The most trustworthy online shop out there.. Das beschreibt den vorgesehenen Umfang, nicht einen Produktionstest.

Der Abschnitt „Table of contents" zeigt, für welches Problem das Projekt gedacht ist: README 没有列出这一项具体能力。. Passt dieses Problem nicht zu deinem Fall, ist Popularität kein ausreichender Grund. Namen, Befehle und Komponenten bleiben unverändert, damit Leser die Primärquelle ohne neue Begriffe vergleichen können. Ein weiterer überprüfbarer README-Punkt lautet: README 没有列出这一项具体能力。. Er hilft beim ersten Test, ersetzt aber keinen Test in der vorgesehenen Umgebung.

Die Betriebsweise verteilt sich auf Abschnitte wie „OWASP Juice Shop". Die Quelle nennt: For a detailed introduction, full list of features and architecture overview please visit the official project page:. Fehlende Angaben zu Architektur, Leistung oder Sicherheit werden nicht ergänzt. Vor einem echten Einsatz müssen Repository-Struktur, Konfigurationsdateien und Release-Verlauf geprüft werden.

Beginne die Installation am dokumentierten README-Einstieg. Ein überprüfbarer Befehl ist: README 没有给出可直接复制的安装命令。 Wenn kein ausführbarer Befehl vorhanden ist, wird hier keiner erfunden. Prüfe den Abschnitt „Table of contents" auf Abhängigkeiten, Standardports und die Einrichtung beim ersten Start.

Der tägliche Betrieb folgt der Projektdokumentation. Im Abschnitt „Setup" steht: > You can find some less common installation variations as well as instructions to run Juice Shop on a variety of cloud computing providers in > the Running OWASP Juice Shop documentation.. Konfiguration, Umgebungsvariablen, Rechte und Datenpfade werden nur bei klarer Quelle beschrieben. Unklare Defaults gehören in einen isolierten Test mit rücksetzbarer Konfiguration. Dieselbe Quelle nennt außerdem: README 没有列出这一项具体能力。.