|
| 1 | +{ |
| 2 | + "skill_name": "readme-enhance", |
| 3 | + "evals": [ |
| 4 | + { |
| 5 | + "id": 1, |
| 6 | + "prompt": "Enhance the README for this Node.js CLI tool project. The repo is at github.com/acme/taskrunner, it has a package.json with name 'taskrunner' version '2.1.0', a LICENSE file with MIT, a .github/workflows/ci.yml, and the primary language is TypeScript.", |
| 7 | + "expected_output": "README.md updated with shields.io badges (version, build, license, language, stars, downloads, PRs welcome), an SVG infographic saved to .github/readme-infographic.svg with 1280x640 viewBox, and a collapsible prompt details section in the README.", |
| 8 | + "files": [ |
| 9 | + "README.md", |
| 10 | + "package.json", |
| 11 | + "LICENSE", |
| 12 | + ".github/workflows/ci.yml" |
| 13 | + ], |
| 14 | + "expectations": [ |
| 15 | + "README.md contains at least one badge URL matching 'https://img.shields.io/' with 'style=for-the-badge' query parameter", |
| 16 | + "README.md contains an npm version badge with 'npm/v/taskrunner' in the URL", |
| 17 | + "README.md contains a license badge referencing MIT", |
| 18 | + "An SVG file is written to .github/readme-infographic.svg containing a root <svg> element with viewBox='0 0 1280 640'", |
| 19 | + "README.md contains a <details> block with <summary> referencing 'infographic generation prompt' or similar wording", |
| 20 | + "README.md contains an <img> tag referencing '.github/readme-infographic.svg' wrapped in a center-aligned <p> element" |
| 21 | + ] |
| 22 | + }, |
| 23 | + { |
| 24 | + "id": 2, |
| 25 | + "prompt": "Enhance the README for my Python library 'dataweave' hosted at github.com/jsmith/dataweave. It has a pyproject.toml with version 0.8.3, an Apache-2.0 LICENSE, GitHub Actions CI, and Codecov integration.", |
| 26 | + "expected_output": "README.md updated with Python-specific badges (PyPI version, build status, coverage, license, language), an SVG infographic using the Library/SDK balanced layout, and the collapsible prompt section.", |
| 27 | + "files": [ |
| 28 | + "README.md", |
| 29 | + "pyproject.toml", |
| 30 | + "LICENSE", |
| 31 | + ".github/workflows/ci.yml" |
| 32 | + ], |
| 33 | + "expectations": [ |
| 34 | + "README.md contains a PyPI version badge with 'pypi/v/dataweave' in the URL and 'logo=python' parameter", |
| 35 | + "README.md contains a Codecov coverage badge with 'codecov/c/github/jsmith/dataweave' in the URL", |
| 36 | + "README.md contains a license badge referencing Apache 2.0 or Apache_2.0", |
| 37 | + "The SVG infographic contains a linearGradient element for the background fill", |
| 38 | + "README.md badge lines appear after the first H1 heading and before the infographic image element", |
| 39 | + "The SVG infographic contains text elements with the project name 'dataweave'" |
| 40 | + ] |
| 41 | + }, |
| 42 | + { |
| 43 | + "id": 3, |
| 44 | + "prompt": "Enhance the README for github.com/acme/taskrunner with --badges-only mode. It has package.json (name: taskrunner, version: 3.0.0), MIT LICENSE, and GitHub Actions CI.", |
| 45 | + "expected_output": "README.md updated with badges only; no infographic SVG file is generated and no infographic image tag is inserted into the README.", |
| 46 | + "files": [ |
| 47 | + "README.md", |
| 48 | + "package.json", |
| 49 | + "LICENSE", |
| 50 | + ".github/workflows/ci.yml" |
| 51 | + ], |
| 52 | + "expectations": [ |
| 53 | + "README.md contains shields.io badge markdown with 'style=for-the-badge'", |
| 54 | + "No SVG file is created at .github/readme-infographic.svg", |
| 55 | + "README.md does not contain an <img> tag referencing 'readme-infographic'", |
| 56 | + "README.md contains a build status badge referencing 'github/actions/workflow/status'", |
| 57 | + "Badges are ordered with status/version badges appearing before engagement badges (stars, PRs welcome)" |
| 58 | + ] |
| 59 | + }, |
| 60 | + { |
| 61 | + "id": 4, |
| 62 | + "prompt": "Enhance the README for github.com/acme/taskrunner with --infographic-only mode. It has package.json (name: taskrunner, version: 1.5.0), MIT LICENSE, and TypeScript source files.", |
| 63 | + "expected_output": "An SVG infographic is generated and placed in the README, but existing badges are not modified or added.", |
| 64 | + "files": ["README.md", "package.json", "LICENSE"], |
| 65 | + "expectations": [ |
| 66 | + "An SVG file is written to .github/readme-infographic.svg with viewBox='0 0 1280 640'", |
| 67 | + "README.md contains an <img> tag or <picture> element referencing the infographic SVG", |
| 68 | + "README.md contains a <details> block with the collapsible generation prompt section", |
| 69 | + "No new shields.io badge lines are added to README.md beyond any that already existed", |
| 70 | + "The SVG contains a footer section with an install command or project link text" |
| 71 | + ] |
| 72 | + }, |
| 73 | + { |
| 74 | + "id": 5, |
| 75 | + "prompt": "Enhance the README for a project at github.com/devuser/myutil that has no package.json, no Cargo.toml, no pyproject.toml, and no go.mod. It only has a README.md, some .sh scripts, and a LICENSE (MIT).", |
| 76 | + "expected_output": "The skill extracts the project name from the git remote URL, generates badges using GitHub-level information (license, stars, last commit), and creates an infographic using available context.", |
| 77 | + "files": ["README.md", "LICENSE"], |
| 78 | + "expectations": [ |
| 79 | + "README.md contains a license badge for MIT even without a package manifest", |
| 80 | + "README.md contains GitHub engagement badges (stars or last-commit) using 'devuser/myutil' in the URL", |
| 81 | + "No registry-specific version badge (npm, PyPI, crates.io) is present since there is no package manifest", |
| 82 | + "An SVG infographic is still generated at .github/readme-infographic.svg with valid SVG markup", |
| 83 | + "The SVG infographic has a 1280x640 viewBox and contains the project name 'myutil' in a text element" |
| 84 | + ] |
| 85 | + }, |
| 86 | + { |
| 87 | + "id": 6, |
| 88 | + "prompt": "Enhance the README for github.com/acme/nightvision. It has package.json (name: nightvision, version: 1.0.0), MIT LICENSE, and a .claude/github-social.local.md config with dark_mode set to 'both'.", |
| 89 | + "expected_output": "README.md uses a <picture> element with <source> tags for dark and light mode infographic variants, and both SVG files are generated.", |
| 90 | + "files": [ |
| 91 | + "README.md", |
| 92 | + "package.json", |
| 93 | + "LICENSE", |
| 94 | + ".claude/github-social.local.md" |
| 95 | + ], |
| 96 | + "expectations": [ |
| 97 | + "README.md contains a <picture> element with a <source> tag having media='(prefers-color-scheme: dark)' and srcset referencing a dark variant SVG", |
| 98 | + "README.md contains a <source> tag with media='(prefers-color-scheme: light)' referencing the light variant SVG", |
| 99 | + "Two SVG files are generated: the default infographic and a dark mode variant (e.g., readme-infographic-dark.svg)", |
| 100 | + "The <picture> element contains a fallback <img> tag referencing the default infographic SVG" |
| 101 | + ] |
| 102 | + }, |
| 103 | + { |
| 104 | + "id": 7, |
| 105 | + "prompt": "Enhance the README for github.com/bigcorp/megaplatform. It has package.json (name: megaplatform, version: 5.2.1), MIT LICENSE, GitHub Actions CI, Codecov, a Discord community link in README, a FUNDING.yml, docs at docs.megaplatform.io, and TypeScript as primary language. Ensure badges follow proper ordering and stay within limits.", |
| 106 | + "expected_output": "README.md contains a comprehensive but bounded badge set (8-12 badges) ordered by importance: status first, then version, quality, language, metrics, engagement, community, and support last.", |
| 107 | + "files": [ |
| 108 | + "README.md", |
| 109 | + "package.json", |
| 110 | + "LICENSE", |
| 111 | + ".github/workflows/ci.yml", |
| 112 | + ".github/FUNDING.yml" |
| 113 | + ], |
| 114 | + "expectations": [ |
| 115 | + "README.md contains between 8 and 12 shields.io badge lines (not exceeding 15)", |
| 116 | + "The build status badge appears before the npm version badge in the README source order", |
| 117 | + "The version badge appears before stars/downloads engagement badges in source order", |
| 118 | + "README.md contains a Discord badge with 'logo=discord' in the URL", |
| 119 | + "README.md contains a sponsor or funding-related badge since FUNDING.yml exists", |
| 120 | + "README.md contains a documentation badge referencing docs.megaplatform.io" |
| 121 | + ] |
| 122 | + } |
| 123 | + ] |
| 124 | +} |
0 commit comments