docs: prepare README for the Claude plugin directory
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
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.shreads the hook payload, checks the folders above the edited file forfeatures/, and runs the validator, which readspubspec.yamland Dart files in the workspace and writes nothing - In the Hooks section, state that
check_vgv_cli.shlooks upvery_goodonPATHor in the pub cache ($PUB_CACHEor~/.pub-cache) and runsvery_good --version, with no file writes or network calls - In the MCP Integration section, state what each Very Good CLI tool writes or fetches:
createwrites new packages into the project,packages_getdownloads dependencies from pub.dev,testwrites coverage output, and whatpackages_check_licensesreads - State that
scripts/sync_reference.dartis a maintainer script the plugin never runs, and that it fetches the public VGV Engineering FFCA pages and writesreferences/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
- No Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from VeryGoodOpenSource/vgv-ffca-plugin
-
chore
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
-
bug
Difficulty 1/5 Under an hour Newbie friendliness 85/100
-
chore
Difficulty 4/5 3-5 days Newbie friendliness 35/100
-
bug
Difficulty 3/5 1-2 days Newbie friendliness 76/100
-
feature
Difficulty 3/5 1-2 days Newbie friendliness 48/100
All issues in VeryGoodOpenSource/vgv-ffca-plugin
Similar issues
-
good first issue
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
StabilityNexus/Zplit#77 · 1 comment ·
-
🚀 [firebase_core] Bump Firebase C++ SDK (14.1.0 → 14.2.0)Possibly taken @SelaseKay claimed this today. OpenNeeds Attention type: enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
firebase/flutterfire#18977 · 1 comment ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 67/100
-
agent: is checked on a wrapper holding several checkables answers from the first one in tree orderOpenbug
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
AlphaWaveSystems/flutter-probe#865 ·
Maintainers usually reply within 1 day
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
ubuntu/app-center#2306 ·
Maintainers usually reply within 1 day