CtrlK
BlogDocsLog inGet started
Tessl Logo
SkillPublic

readme-lint

Linter di conformità per README. Valida che un README rispetti gli standard ecosistema fgt-sdk, i principi anti-AI-slop (wwewtech/anti-slop-design), no-ai-slop (petergyang/no-ai-slop su zread.ai) e diagram-design (cathrynlavery/diagram-design).

Quality

74%

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

Fix and improve this skill with Tessl

tessl review fix ./skill/readme-lint/SKILL.md
SKILL.md
Quality
Evals
Security

readme-lint — Skill Linter README (con Anti-Slop e No-AI-Slop)

Valida che un README.md rispetti gli standard ecosistema fgt-sdk e Biodoia, inclusi i principi anti-AI-slop, no-ai-slop e diagram-design. Restituisce un report di conformità con errori, warning e suggerimenti di correzione.

Regole di controllo fgt-sdk (checklist base)

#RegolaSeveritàDescrizione
1Titolo principale (#)ErroreDeve esserci esattamente un H1 con il nome del progetto
2BadgeAvvisoAlmeno un badge (build, license, o equivalent)
3TL;DRErroreSezione "Cosa fa" o descrizione in una frase
4InstallazioneErroreIstruzioni di build/run presenti
5Bind loopbackErroreNessun riferimento a 0.0.0.0; solo 127.0.0.1:<porta>
6Segreti hardcodatiErroreNessuna chiave API, token o password in chiaro
7LicenzaErroreRiferimento a file LICENSE o tipo licenza
8Documentazione correlataAvvisoTabella con file AGENTS.md, QWEN.md, ecc.
9Standard ecosistemaAvvisoCitazione aigoproxy, goleciave, PebbleDB, zero CGO
10Data alignInfoData di allineamento nel footer (*docs(align): ...*)

Regole Anti-AI-Slop (da wwewtech/anti-slop-design)

#RegolaSeveritàDescrizione
11No AI Dark Mode BlobErroreNessun radial-gradient indigo/purple sfocato
12No Raw Emojis as IconsErroreNessun emoji grezzo usato come icona funzionale
13No Fabricated Vanity StatsErroreNessuna stat vanity senza fonte (+99.9% Uptime, ecc.)
14No Screaming Eyebrow LabelsAvvisoNessuna label maiuscola tracciata (OVERVIEW, FEATURES)
15No Single-Word Italic AccentsAvvisoNessuna parola arbitraria in corsivo/gradient nel titolo
16No Redundant Metric DuplicationAvvisoUna sola fonte di verità per le metriche per viewport
17No Vanity Visual Space-WastersAvvisoNessuna mappa 3D o blob decorativo senza dati azionabili
18No Broken PlaceholdersErroreNessun via.placeholder.com, link rotti, immagini sfocate
191-to-3 RuleAvviso1 azione primaria per sezione, max 3 secondarie
20Strict Ban on DuplicationAvvisoUn brand mark, un CTA primario, un filtro globale per viewport

Regole No-AI-Slop (da petergyang/no-ai-slop su zread.ai)

#RegolaSeveritàDescrizione
21No Binary ContrastAvvisoNessuna frase "Non è X. È Y." — vai diretto a Y
22No Throat-Clearing OpenersAvvisoNessuna apertura tipo "Ecco la cosa", "Lascia che sia chiaro"
23No Banned WordsErroreNessuna parola da: delve, foster, leverage, utilize, facilitate, empower, streamline, robust, cutting-edge, paradigm shift, game changer, tapestry, realm, beacon, multifaceted, meticulous, intricate, paramount, transformative, elevate, embark, supercharge, harness, ever-evolving
24No Faux-Insight SetupsAvvisoNessuna frase tipo "Questo è ciò che nessuno ti dice"
25No Colon RevealsAvvisoNessun reveal drammatico dopo due punti
26No Importance PufferyAvvisoNessuna frase tipo "segna un momento cruciale"
27No Weasel AttributionAvvisoNessuna attribuzione vaga tipo "esperti concordano"
28No Synonym CyclingAvvisoSe la parola chiara è giusta, ripetila
29No Fake-Profound KickerAvvisoNessuna metafora mic-drop alla fine
30No Formatting SlopAvvisoNessun emoji in heading, bold a metà frase, header sopra sezioni di 2 frasi
31Active VoiceInfoPreferisci voce attiva ("Il team ha rilasciato" non "la decisione è emersa")
32Concrete and SpecificInfoUsa nomi, numeri, date, meccanismi, esempi invece di astrazioni

Regole Diagram-Design (da cathrynlavery/diagram-design)

#RegolaSeveritàDescrizione
33No Mermaid SlopAvvisoNessun diagramma Mermaid generico; usa HTML+SVG self-contained
34Self-Contained DiagramsInfoDiagrammi architetturali come singolo file .html
35Brand OnboardingInfoColori e font del README abbinati al brand del progetto

Output

{
  "file": "README.md",
  "score": 85,
  "errors": ["Nessun H1 trovato", "Riferimento a 0.0.0.0 riga 42", "Parola banned 'leverage' riga 15"],
  "warnings": ["Nessun badge presente", "Emoji grezzo come icona riga 23", "Throat-clearing opener riga 8"],
  "suggestions": ["Aggiungi badge build", "Sostituisci emoji con testo/SVG", "Rimuovi throat-clearing opener"],
  "anti_slop_axes": {
    "anti_slop_purity": 4,
    "ux_speed_1_to_3": 4,
    "typographic_discipline": 5,
    "spacing_geometry": 4,
    "micro_interactions": 4,
    "accessibility": 4,
    "mobile_linearity": 4
  }
}

7-Axis Pre-Emit Quality Gate (da anti-slop-design)

Ogni asse deve raggiungere ≥ 4/5 prima del completamento:

AsseMetricaSoglia
1. Anti-Slop PurityLibertà da cliché AIZero gradienti purple, zero emoji come icona, zero vanity stats
2. UX Speed & 1-to-3 RuleChiarezza logica1 azione primaria, max 3 secondarie, filtri page-level unificati
3. Typographic DisciplinePersonalità e gerarchiaMax 2 font famiglie, tabular numbers su metriche, body ≤ 75ch
4. Spacing & Geometric MathRitmo spazialeGrid 4px/8pt, R_inner = max(0, R_outer - padding)
5. Micro-Interactions & MotionSensazione fisicaTransizioni < 200ms, :active { transform: scale(0.97) }
6. Accessibility & Keyboard FlowWCAG 2.1 AAFocus ring visibile, no outline: none nudo, tag semantici HTML
7. Mobile & Responsive LinearityStabilità cross-deviceStacking verticale pulito, zero overflow orizzontale, touch target ≥ 44px

Trigger

Usa questa skill quando l'utente chiede di:

  • Verificare la conformità di un README
  • Fare lint su un README prima di un push
  • Allineare un README agli standard fgt-sdk + anti-slop + no-ai-slop
  • De-sloppare un README generato da AI
Repository

biodoia/readmago

Path

skill/readme-lint/SKILL.md

Last updated
First committed

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.