standards-check

Checks that a project contains required standard files like README.md.

24.7k|2.3k|Updated Apr 28, 2023

Search Tags:#standards #Conventions #project audit #Claude Agent SDK #ReadMe #file check

One-click install

npx skills add https://github.com/promptfoo/promptfoo --skill standards-check

Or copy as Structured Prompt for Agent▼

Please help me install this Agent Skill.
Skill: standards-check
Source: https://github.com/promptfoo/promptfoo/tree/main/examples/claude-agent-sdk/plugins/sample-plugin/skills/standards-check
Command: npx skills add https://github.com/promptfoo/promptfoo --skill standards-check

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Projects often drift from organizational conventions, missing required files such as README.md documentation. Manually auditing repositories for these standards is repetitive and error-prone.

Core Features & Use Cases

Convention Verification: Checks that a project includes required files, starting with README.md for project documentation.
Missing File Reporting: Reports which required files are absent so maintainers can fix gaps quickly.
Use Case: Before merging a new repository into your organization, run this check to confirm it includes baseline documentation and identify anything missing.

Quick Start

Ask the assistant to check whether this project follows standard conventions and report any missing required files.

Frequently Asked Questions about standards-check

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I check if a project follows standard conventions?▼

Run this Skill against the project directory. It verifies that required files such as README.md exist and reports which required files are missing so you can add them.

What files does a project standards check look for?▼

This check looks for README.md, which provides project documentation. It reports the file as missing if it is not present at the project root.

Can I use this check in a Claude agent plugin?▼

Yes. This Skill ships as part of a sample plugin for the Claude Agent SDK in the promptfoo examples, so it runs inside that plugin environment when the agent is asked to verify project conventions.

What are the limitations of a file-presence standards check?▼

It only verifies that required files exist, not their content quality or correctness. A README.md could be empty or outdated and still pass the check.