docs: prepare README for the Claude plugin directory

Offen Anfängerfreundlich
#46 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Anfängerfreundlichkeit
82/100
Issue-Typ
Dokumentation
Klarheit
Klar beschrieben
Aktivitätsstatus
Aktiv
Tech-Stack
dart, markdown
Bereich
documentation

Rechercherichtung

Aktualisiere die README des Plugins und konzentriere dich auf die Abschnitte Hooks und MCP Integration sowie das Wartungsskript scripts/sync_reference.dart. Prüfe zuerst die README anhand jeder Anforderung und führe dann den Markdown-Linter und die Rechtschreibprüfung aus. Fertig ist die Aufgabe, wenn die README den Installationsbefehl sowie das angegebene Datei-, Netzwerk- und Tool-Verhalten enthält und beide Prüfungen erfolgreich sind.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

documentation

Description

The directory shows the README as the listing's description. Its security scan also flags any behavior the README doesn't mention. The README already explains each skill, the validator's rules and both hooks well, including that the PreToolUse hook auto-approves Very Good CLI MCP calls. This issue fills in the install line and the file and network details the directory looks for.

Requirements

  • Add an install line that works in one step: /plugin install vgv-ffca-plugin --marketplace VeryGoodOpenSource/very-good-claude-code-marketplace
  • In the Hooks section, state that validate_layers.sh reads the hook payload, checks the folders above the edited file for features/, and runs the validator, which reads pubspec.yaml and Dart files in the workspace and writes nothing
  • In the Hooks section, state that check_vgv_cli.sh looks up very_good on PATH or in the pub cache ($PUB_CACHE or ~/.pub-cache) and runs very_good --version, with no file writes or network calls
  • In the MCP Integration section, state what each Very Good CLI tool writes or fetches: create writes new packages into the project, packages_get downloads dependencies from pub.dev, test writes coverage output, and what packages_check_licenses reads
  • State that scripts/sync_reference.dart is a maintainer script the plugin never runs, and that it fetches the public VGV Engineering FFCA pages and writes references/ffca/
  • Markdown lint and spell check pass

Additional Context

  • Pre-submission checklist
  • claude plugin validate . advice: "This README has no line that installs "vgv-ffca-plugin" from a marketplace."
Vorherrschende Sprache
Dart
Sterne
7
Forks
2
Ø Merge
9 Std. 59 Min.
Gemergte PRs (30 T.)
7

Entwicklungsumgebung

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus VeryGoodOpenSource/vgv-ffca-plugin

Alle Issues in VeryGoodOpenSource/vgv-ffca-plugin

Ähnliche Issues

Weitere Issues zu Dart

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.