reviewdog/reviewdog: Redaktioneller README-Leitfaden

reviewdog/reviewdog beschreibt sich im README als „🐶 Automated code review tool integrated with any code analysis tools regardless of programming language". Dieser Text bleibt bei Fakten, die im Repository überprüfbar sind. Sterne, Forks und Badges zeigen Aufmerksamkeit, aber keine Qualität. Unter „README" steht: reviewdog - A code review dog who keeps your codebase healthy.. Das beschreibt den vorgesehenen Umfang, nicht einen Produktionstest.

Der Abschnitt „Table of Contents" zeigt, für welches Problem das Projekt gedacht ist: Reporter: GitHub PR Checks (-reporter=github-pr-check). 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: [Reporter: Local (-reporter=local) [default]](#reporter-local--reporterlocal-default). Er hilft beim ersten Test, ersetzt aber keinen Test in der vorgesehenen Umgebung.

Die Betriebsweise verteilt sich auf Abschnitte wie „README". Die Quelle nennt: reviewdog also supports running in the local environment to filter the output of lint tools by diff.. 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: # Install the latest version. (Install it into ./bin/ by default). $ curl -sfL https://raw.githubusercontent.com/reviewdog/reviewdog/fd59714416d6d9a1c0692d872e38e7f8448df4fc/install.sh | sh -s # Specify installation directory ($(go env GOPATH)/bin/) and version. $ curl -sfL https://raw.githubusercontent.com/reviewdog/reviewdog/fd59714416d6d9a1c0692d872e38e7f8448df4fc/install.sh | sh -s -- -b $(go env GOPATH)/bin [vX.Y.Z] # In alpine linux (as it does not come with curl by default) $ wget -O - Wenn kein ausführbarer Befehl vorhanden ist, wird hier keiner erfunden. Prüfe den Abschnitt „Installation" auf Abhängigkeiten, Standardports und die Einrichtung beim ersten Start.