docs: prepare README for the Claude plugin directory

Aperta Adatta ai principianti
#46 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
82/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
dart, markdown
Ambito
documentation

Direzione di ricerca

Aggiorna il README del plugin, concentrandoti sulle sezioni Hooks e MCP Integration e sullo script di manutenzione scripts/sync_reference.dart. Inizia verificando il README rispetto a ciascun requisito, poi esegui il lint Markdown e il controllo ortografico. Il lavoro è completato quando il README include il comando di installazione e il comportamento specificato per file, rete e strumenti, e entrambi i controlli hanno esito positivo.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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."
Lingua principale
Dart
Stelle
7
Fork
2
Merge medio
9h 59m
PR unite (30g)
7

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di VeryGoodOpenSource/vgv-ffca-plugin

Tutte le issue di VeryGoodOpenSource/vgv-ffca-plugin

Issue simili

Altre issue su Dart

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.