eval-readme

Évalue un README GitHub à travers un prisme simple : sert-il son objectif de communication vers un humain pressé ? Référence des signaux dans signals.md à la racine du plugin.

Entrée

Soit un owner/repo (l'agent récupère le README via l'API GitHub), soit le texte du README collé directement.

Procédure

1. Récupérer le contenu. Pour un repo : gh api repos/{owner}/{repo}/readme --jq .content | base64 -d, ou le README brut via raw.githubusercontent.com.
2. Passer les trois grilles ci-dessous.
3. Trancher un verdict et lister des correctifs applicables tout de suite.

Grille 1 : signaux humains (présence = bon)

Screenshots, diagrammes, records de terminal (asciinema, SVG), vidéos, GIF de démo. Structure scannable : titres clairs, exemples de commandes, sections courtes. Un humain sait qu'on lit un README en diagonale et favorise l'image sur le pavé.

Grille 2 : marqueurs IA non assumée (présence = drapeau)