docs: prepare README for the Claude plugin directory

Ouverte Adaptée aux débutants
#46 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Évaluation

Difficulté
2/5
Temps estimé
1-3 heures
Accessibilité débutants
82/100
Type d'issue
Documentation
Clarté
Clairement spécifiée
Activité
Active
Stack technique
dart, markdown
Domaine
documentation

Piste de recherche

Mettez à jour le README du plugin, en vous concentrant sur les sections Hooks et MCP Integration ainsi que sur le script de maintenance scripts/sync_reference.dart. Commencez par vérifier le README au regard de chaque exigence, puis exécutez le linter Markdown et le correcteur orthographique. Le travail est terminé lorsque le README inclut la commande d’installation ainsi que le comportement spécifié concernant les fichiers, le réseau et les outils, et que les deux vérifications réussissent.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

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."
Langage dominant
Dart
Étoiles
7
Forks
2
Merge moyen
9 h 59 min
PR mergées (30 j)
7

Préparer son environnement

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de VeryGoodOpenSource/vgv-ffca-plugin

Toutes les issues de VeryGoodOpenSource/vgv-ffca-plugin

Issues similaires

Plus d'issues Dart

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.