docs: prepare README for the Claude plugin directory

Open Beginner friendly
#46 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
82/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Tech stack
dart, markdown
Domain
documentation

Research direction

Update the plugin README, focusing on its Hooks and MCP Integration sections and the maintainer script scripts/sync_reference.dart. Start by checking the README against each requirement, then run the Markdown lint and spell check. Done means the README includes the install command and the specified file, network, and tool behavior, and both checks pass.

Written by the indexing model from the issue text.

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."
Dominant language
Dart
Stars
7
Forks
2
Avg merge
9h 59m
Merged PRs (30d)
7

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from VeryGoodOpenSource/vgv-ffca-plugin

All issues in VeryGoodOpenSource/vgv-ffca-plugin

Similar issues

More Dart issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.