agentleFS
Sign inStart free
roronoazoroshao369roronoazoroshao369/vibe-coding-os/skills/authoring-skills/SKILL.md

authoring-skills

Skill1 starsChanged 5 months agoMITView on GitHub

Guide for authoring new skills that integrate with the Vibe Coding OS skill system. Covers frontmatter (name, version, introduced_in, last_reviewed, category, tags, status), required sections (Purpose, When to use, Inputs, Workflow, Outputs, Failure modes, Verification checklist, Examples), and the per-skill example convention (see templates/skill-example-template.md). When you are about to create a new skill file in skills/<category>/<skill-name>/SKILL.md. Read this guide first to ensure your skill passes validate:skill-quality and validate:traceability on the first try.

10 other projects use a version of this.

Adopted by

Most recently taken up by

The file

We split this skill into the rules it gives an agent

6 rules. 0 are common, 3 are distinctive, and 3 are very specific to this project.

  • 0

    Common

    Most of the 9 edited versions we read keep these.

  • 3

    Distinctive

    This author's own choices. Worth a look.

  • 3

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    When you are about to create a new skill file in skills/<category>/<skill-name>/SKILL.md.

    line 19
  2. Distinctive:

    Use case (3-5 trigger phrases)

    line 25
  3. Distinctive:

    Add YAML frontmatter with all required fields.

    line 32
  4. Distinctive:

    Write the body in this order: Purpose → When to use → Inputs → Workflow → Outputs → Failure modes → Verification checklist → Examples.

    line 33
  5. Very specific:

    Run npm run validate:skill-quality to confirm compliance.

    line 34
  6. Very specific:

    If a regression test is needed, follow templates/skill-test-template.md.

    line 35

“Common” is measured: kept by at least 6 in 10 of the 9 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Skill: Authoring Skills

Purpose

Guide for authoring new skills that integrate with the Vibe Coding OS skill system. Covers frontmatter (name, version, introduced_in, last_reviewed, category, tags, status), required sections (Purpose, When to use, Inputs, Workflow, Outputs, Failure modes, Verification checklist, Examples), and the per-skill example convention (see templates/skill-example-template.md).

When to use

When you are about to create a new skill file in skills/<category>/<skill-name>/SKILL.md. Read this guide first to ensure your skill passes validate:skill-quality and validate:traceability on the first try.

Inputs

  • Skill purpose (one sentence)
  • Target category (core, prompts, agents, meta, quality, security, memory, etc.)
  • Use case (3-5 trigger phrases)
  • Failure modes (what could go wrong)

Workflow

  1. Draft the skill's purpose in 1-2 sentences.
  2. List 3-5 "When to use" trigger phrases.
  3. Add YAML frontmatter with all required fields.
  4. Write the body in this order: Purpose → When to use → Inputs → Workflow → Outputs → Failure modes → Verification checklist → Examples.
  5. Run npm run validate:skill-quality to confirm compliance.
  6. If a regression test is needed, follow templates/skill-test-template.md.

Outputs

  • A new SKILL.md file in the appropriate skills/<category>/<skill-name>/ directory.
  • A passing validate:skill-quality run.

Failure modes

  1. Missing frontmatter — gate FAIL on validate:skill-quality. Add all required fields.
  2. Missing required sections — gate FAIL. Use the section order above.
  3. No examples — convention recommends 3 (trivial/standard/advanced). Use templates/skill-example-template.md.
  4. Stale skill — last_reviewed is too old. Update when the skill changes.
  5. No test file — convention recommends 1 test per top-20 priority skill. See Wave B Deliverable 4.

Verification checklist

  • YAML frontmatter is valid (parse with js-yaml)
  • All required sections present in the correct order
  • At least 1 example included
  • last_reviewed date is current
  • validate:skill-quality exits 0
  • Linked from at least one adapter or command (no orphan skills)
  • Optional: test file at tests/skills/<skill-name>.test.mjs

Related files

  • See skills/SKILL.md for the canonical template.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

Check your setup, free