jacobpevans/validate-readme
content-guards/skills/validate-readme/SKILL.md
Validate all README files in the repository for required sections and installation code blocks. Checks section presence using config from .readme-validator.yaml or sensible defaults. Badge URL reachability is checked on-demand via WebFetch.
$ install --global
skillsauthnpx skillsauth add jacobpevans/claude-code-plugins validate-readmeInstall this skill globally with one command. Works with Claude Code, Cursor, and Windsurf.
Security Scan Results
3 of 9 scanners reported clean
Some scanners were skipped, did not run, or reported a non-clean status. Review each row below.
3
Scanners Passed
9
Scanners in report
Clean
TrivyContainer and dependency vulnerability scanner
95%
Clean
SemgrepStatic code analysis for vulnerabilities
95%
Clean
mcp-scan (Snyk)Model Context Protocol security validation
95%
Skipped
Snyk (dep)Open source security scanning
50%
Skipped
Socket.devSupply chain security analysis
50%
Skipped
VirusTotalMulti-engine malware detection
50%
Skipped
CrowdStrikeAdvanced threat intelligence
50%
Skipped
OSV-ScannerOpen Source Vulnerability database check
50%
Skipped
OWASP Dep-Check
50%
Last scanned: Apr 27, 2026, 9:13 PM153.3s1 file scanned
SKILL.md
- name:
- validate-readme
- description:
- >-
Validate README
Run a comprehensive audit of all README.md files in the current repository.
Usage
/validate-readme
Steps
1. Find all README files
Find all README*.md files in the repository, excluding .git/ and .claude/
directories.
2. Validate each README
For each README found, check:
- Required sections present (from
.readme-validator.yamlor defaults) - Installation section contains at least one code block
- Optional sections present (warnings only)
Badge URL reachability may be checked on-demand using WebFetch for any badge images found in the README.
3. Report results
Output a summary table:
| File | Status | Issues | |------|--------|--------| | ./README.md | PASS | -- | | ./plugin/README.md | WARN | Missing: Contributing |
Configuration
Place a .readme-validator.yaml file anywhere in the directory tree above the
README being validated. The hook searches upward up to 10 levels.
required_sections:
- Installation
- Usage
optional_sections:
- Contributing
- License
- API
Defaults (used when no config file is found):
required_sections:Installation,Usageoptional_sections:Contributing,License,API
Related Skills
- code-quality-standards (code-standards) — broader code quality standards that include documentation requirements
Related Skills
jacobpevans/self-hosted-runners
documentation
VerifiedTrustedCommunity
Use when editing GitHub Actions workflow files (.github/workflows/*.yml) in JacobPEvans repos. Documents when to target self-hosted RunsOn runners vs GitHub-hosted runners, the v3 label catalog used across the org, the required github.run_id segment, and the GitHub App allowlist prereq.
2SKILL.mdUpdated May 16, 2026
jacobpevans/refresh-repo
testing
VerifiedTrustedCommunity
Check PR merge readiness, sync local repo, cleanup stale worktrees; optional cross-repo sweep and stale-branch prune modes
2SKILL.mdUpdated Apr 28, 2026
jacobpevans/rebase-pr
tools
VerifiedTrustedCommunity
Local rebase-merge workflow for pull requests with signed commits
2SKILL.mdUpdated Apr 28, 2026
jacobpevans/gh-cli-patterns
tools
VerifiedTrustedCommunity
Canonical reference for all gh CLI command shapes used by skills in this plugin. Defines the placeholder convention, allowed --json fields, GraphQL fallback rules, -f/-F/--raw-field flag semantics, the PR-readiness gate, code-scanning alert query, review-thread fetch/count/resolve mutations, and heredoc bodies. Prevents Unknown JSON field errors and divergent query shapes.
2SKILL.mdUpdated Apr 28, 2026