Skip to content

Frontmatter check warns about commas in description #71

@infotexture

Description

@infotexture

What happened?

The frontmatter check says the description passes, but warns that the description field reads like a comma-separated keyword list rather than prose.

What did you expect?

The description is genuinely prose; the validator seems to be just counting commas. Since this is a skill describing UI element types, commas are unavoidable without making the description awkward.

How to reproduce

Sample description field:

description: Helps agents write and edit interface copy (microcopy) for
  digital products — buttons, labels, error messages, forms, onboarding
  flows, empty states, and help text. Use this skill whenever you need to
  produce or improve any text that appears in an app, website, or software
  UI. It applies four core quality standards (purposeful, concise,
  conversational, and clear) and ships with accessibility guidelines,
  research-backed readability benchmarks, error-message patterns, tone
  adaptation frameworks, and fillable templates.

Resulting warning:

  ⚠ description has 8 comma-separated segments, most very short —
    this looks like a keyword list; per the spec, the description should
    concisely describe what the skill does and when to use it

Environment

  • skill-validator version: 1.5.4

Metadata

Metadata

Assignees

No one assigned

    Labels

    bugSomething isn't working

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions