hyhmrright/brooks-lint: Redaktioneller README-Leitfaden
Ein auf README, Metadaten und Lizenz gestützter Leitfaden für hyhmrright/brooks-lint.
Projektumfang
hyhmrright/brooks-lint beschreibt sich im README als „AI code reviews grounded in 12 classic engineering books , decay risk diagnostics with book citations, severity labels, and 6 analysis modes including full-sweep auto-fix". Dieser Text bleibt bei Fakten, die im Repository überprüfbar sind. Sterne, Forks und Badges zeigen Aufmerksamkeit, aber keine Qualität. Unter „README" steht: > "The bearing of a child takes nine months, no matter how many women are assigned." > , Frederick Brooks, The Mythical Man-Month (1975). Das beschreibt den vorgesehenen Umfang, nicht einen Produktionstest.
Geeignete Einsatzfälle
Der Abschnitt „Roadmap" zeigt, für welches Problem das Projekt gedacht ist: v0.5,v0.7: Test Quality Review, Mermaid dependency graph, .brooks-lint.yaml, 10-book expansion. 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: v0.2,v0.4: Plugin infrastructure, six-book framework, decay risk dimensions, benchmark suite. Er hilft beim ersten Test, ersetzt aber keinen Test in der vorgesehenen Umgebung.
Funktionsweise
Die Betriebsweise verteilt sich auf Abschnitte wie „README". Die Quelle nennt: Most code quality tools count lines and cyclomatic complexity. brooks-lint goes deeper , it diagnoses your code against six decay risk dimensions synthesized from twelve classic engineering books, producing structured findings with book. 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.
Installation und erster Start
Beginne die Installation am dokumentierten README-Einstieg. Ein überprüfbarer Befehl ist: # Claude Code /plugin marketplace add hyhmrright/brooks-lint /plugin install brooks-lint@brooks-lint-marketplace # Any other Agent Skills platform , Cursor · Codex · Gemini · Copilot · Windsurf · OpenCode · Kiro · … curl -fsSL https://raw.githubusercontent.com/hyhmrright/brooks-lint/main/scripts/install.sh | bash -s -- <platform> Wenn kein ausführbarer Befehl vorhanden ist, wird hier keiner erfunden. Prüfe den Abschnitt „The Twelve Books" auf Abhängigkeiten, Standardports und die Einrichtung beim ersten Start.