CtrlK
BlogDocsLog inGet started
Tessl Logo

readme-badger

Badge design and selection knowledge base for shields.io badges in README files. Use when writing or updating READMEs, choosing badge layouts, selecting badge styles, adding project health indicators, or picking Simple Icons logo slugs. Covers shields.io URL encoding rules, static vs dynamic badge selection, style variants (flat/flat-square/for-the-badge/social/plastic), layout patterns (two-tier/inline/centered), project-type badge sets for Python/JS/Rust/Claude plugins, color reference, non-obvious logo slugs, and common anti-patterns to avoid.

74

Quality

93%

Does it follow best practices?

Run evals on this skill

Adds up to 20 points to the overall score

View guide
SecuritybySnyk

Passed

No findings from the security scan

SKILL.md
Quality
Evals
Security

Quality

Content

86%Weight 40%Scale 1-5

Reviews the quality of instructions and guidance provided to agents. Good implementation is clear, handles edge cases, and produces reliable results.

A strong reference-style skill body: fully actionable with copy-paste badge markup, explicit decision flowcharts, and exemplary progressive disclosure to real, well-organized reference files. The only deductions are minor duplication (slug-mistake examples and the Claude badge URL repeated across sections) and the absence of an explicit post-assembly render/verify feedback loop.

Suggestions

Consolidate slug verification: the 'Broken slugs' item in Common Mistakes repeats the exact examples from the Non-Obvious Slugs table ('bash'/'gnubash', 'vue'/'vuedotjs'); replace the repetition with a single pointer to the table and keep only the 'verify against Simple Icons before use' instruction.

Add a final verification step to 'Building a Badge Step by Step': after assembling the URL, check that the slug renders (e.g. open the URL or compare against the catalog) and, if the icon is missing, correct the slug per the Non-Obvious Slugs table — this closes the workflow with an explicit feedback loop.

Deduplicate the Claude badge example: the full Claude_Code-compatible-D97757 URL appears in both the walkthrough and the Claude Code Plugin section; the plugin section could reference the walkthrough example or show only the distinct variants (MCP, skills, agents, commands).

DimensionReasoningScore

Conciseness

The body is dense and reference-like with no explanations of concepts Claude already knows (no 'what is a README' padding), and tables/flowcharts carry high information per token. It is not a 5 because of minor duplication: the non-obvious slug mistakes appear both in the 'Non-Obvious Slugs' table and again verbatim under 'Broken slugs' ('Using `bash` instead of `gnubash`, `vue` instead of `vuedotjs`'), and the Claude badge URL is repeated between the step-by-step walkthrough and the Claude Code Plugin section. It is above 3 because nothing is padding or already-known explanation.

4 / 5

Actionability

Guidance is fully executable and copy-paste ready: the 'Building a Badge Step by Step' section produces a complete URL and markdown snippet in 7 concrete steps, project-type sections give complete badge rows (Python/npm/Rust reference-style blocks), and colors, endpoints, and slugs are given as exact lookup tables. Common cases are comprehensively covered, matching anchor 5.

5 / 5

Workflow Clarity

Decision workflows are explicitly sequenced via three mermaid flowcharts (style selection, logoColor choice, dynamic-vs-static) plus a numbered step-by-step badge construction, and 'Broken slugs' instructs 'Verify slugs against Simple Icons before use' — a concrete checkpoint. It falls short of anchor 5's 'explicit validation steps; feedback loops' because there is no render/verify checkpoint after assembling a badge URL (e.g. preview the URL or check the rendered SVG) with an error-recovery loop; it is above 3 because the decision sequences are unambiguous and the task is non-destructive, so no validation cap applies.

4 / 5

Progressive Disclosure

The body keeps core decision logic inline and pushes bulk detail to five real, well-signaled reference files, each linked at its point of need ('For the complete query parameter reference... see [Shields.io API Reference](./references/shields-io-api.md)') and catalogued with one-line descriptions in a References section. All referenced files exist and are one level deep (their outbound relative links are example badge targets in samples, not nested references), matching anchor 5's clear overview with one-level-deep navigation.

5 / 5

Total

18

/

20

Passed

Description

100%Weight 40%Scale 1-5

Based on the skill's description, can an agent find and select it at the right time? Clear, specific descriptions lead to better discovery.

An exemplary description: third-person voice, a concrete 'what' with enumerated capability areas, an explicit 'Use when...' clause with natural trigger phrases, and a distinct niche (shields.io/README badges) with minimal overlap risk. It is long but every clause carries a specific capability or trigger term, so the length is informational rather than padded.

DimensionReasoningScore

Specificity

The description enumerates multiple concrete capabilities with specific variants: 'shields.io URL encoding rules, static vs dynamic badge selection, style variants (flat/flat-square/for-the-badge/social/plastic), layout patterns (two-tier/inline/centered), project-type badge sets for Python/JS/Rust/Claude plugins, color reference, non-obvious logo slugs, and common anti-patterns.' Coverage is comprehensive across the skill's sub-topics with no meaningful gaps, matching the anchor 5 rather than 4 (which allows minor gaps).

5 / 5

Completeness

Both questions are answered explicitly: 'what' via 'Badge design and selection knowledge base for shields.io badges in README files... Covers [enumerated topics]' and 'when' via 'Use when writing or updating READMEs, choosing badge layouts, selecting badge styles...'. This mirrors the anchor-5 example structure of concrete what + explicit Use-when trigger phrases.

5 / 5

Trigger Term Quality

Natural user phrases are comprehensively covered: 'writing or updating READMEs', 'choosing badge layouts', 'selecting badge styles', 'adding project health indicators', 'picking Simple Icons logo slugs', plus domain names 'shields.io' and 'badges'. These match what a user would naturally say when needing this skill (e.g. 'add badges to my README', 'pick a badge style'), satisfying anchor 5's synonym coverage; anchor 4 would require actually-missing natural terms.

5 / 5

Distinctiveness Conflict Risk

The niche is clear and tightly scoped ('shields.io badges in README files', 'Simple Icons logo slugs') with triggers unlikely to fire for unrelated skills; only a hypothetical generic 'documentation style' skill could partially overlap, which is minimal conflict risk matching anchor 5.

5 / 5

Total

20

/

20

Passed

Validation

93%

Checks the skill against the spec for correct structure and formatting. All validation checks must pass before discovery and implementation can be scored.

Validation — 15 / 16 Passed

Validation for skill structure

CriteriaDescriptionResult

relative_links

Relative link issues: 1 missing

Warning

Total

15

/

16

Passed

Repository
Jamie-BitFlight/claude_skills
Reviewed

Table of Contents

Is this your skill?

If you maintain this skill, you can claim it as your own. Once claimed, you can manage eval scenarios, bundle related skills, attach documentation or rules, and ensure cross-agent compatibility.