docs: prepare README for the Claude plugin directory

Abierto Apto para principiantes
#46 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
82/100
Tipo de issue
Documentación
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
dart, markdown

Línea de trabajo

Actualiza el README del plugin, centrándote en las secciones Hooks y MCP Integration y en el script de mantenimiento scripts/sync_reference.dart. Empieza comprobando el README con cada requisito y, después, ejecuta el linter de Markdown y el corrector ortográfico. La tarea estará terminada cuando el README incluya el comando de instalación y el comportamiento especificado para archivos, red y herramientas, y ambas comprobaciones se superen.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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."
Lenguaje dominante
Dart
Estrellas
7
Forks
2
Merge medio
9 h 59 min
PR fusionados (30 d)
7

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de VeryGoodOpenSource/vgv-ffca-plugin

Todos los issues de VeryGoodOpenSource/vgv-ffca-plugin

Issues similares

Más issues de Dart

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.