Skill frontmatter does not follow the Developer-Tools-Directory skills standard

Offen
#79 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 1 Tag

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
3/5
Geschätzter Aufwand
1-2 Tage
Anfängerfreundlichkeit
45/100
Issue-Typ
Dokumentation
Klarheit
Klar beschrieben
Aktivitätsstatus
Aktiv
Tech-Stack
markdown, python, yaml

Rechercherichtung

Open skills/state-bags/SKILL.md first to see the current title/description/globs/standards-version frontmatter, then read the Developer-Tools-Directory standards/skills.md it cites. The change spans all ten skills/*/SKILL.md files plus CLAUDE.md, AGENTS.md, .cursorrules and CONTRIBUTING.md, and the acceptance criteria add a frontmatter check to the MCP suite run with cd mcp-server && python -m pytest. Done means every skill carries the agreed fields and CI fails when one is missing.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

help wanted severity: low tech-debt

Summary

All 10 skills use frontmatter title, description, standards-version (and globs), but the Developer-Tools-Directory skills standard (standards/skills.md) requires name (kebab-case, matching the folder), description (under 200 characters, starting with a verb) and triggers (3-8 natural-language phrases), plus a body with "When to use" / "When NOT to use" sections.

Where

  • skills/*/SKILL.md (frontmatter of all 10 skills, for example skills/state-bags/SKILL.md:1-6)
  • CLAUDE.md and CONTRIBUTING.md (now say to match the existing files until the skills are migrated)

Details

---
title: State Bags
description: Modern data synchronization using State Bags instead of TriggerClientEvent patterns
globs: ["**/*.lua", "**/*.js", "**/*.cs"]
standards-version: 1.10.0
---

The standard's required shape is:

---
name: state-bags
description: Sync entity and player data with State Bags instead of TriggerClientEvent.
triggers:
  - "sync data to clients"
  - "state bag"
  - "replicate entity state"
---

No skill has name or triggers. The docs were corrected to describe the current files (see #48), which leaves the repo knowingly out of step with the standard.

Impact

Agents and tooling that route skills by name/triggers (as the standard intends) get nothing from these skills, and contributors see two conflicting conventions. A future standards check over skills would fail every file.

Suggested fix

  • Decide whether this repo adopts the standard (recommended, since sibling repos are expected to) or the standard documents the title/standards-version shape.
  • If adopting: add name and triggers to each skill, trim description to the standard's form, keep or drop globs as the standard's optional scope, and add the "When to use" / "When NOT to use" sections.
  • Then update CLAUDE.md, AGENTS.md, .cursorrules and CONTRIBUTING.md to state a single convention, and add a frontmatter check (parse YAML, required fields present) to the MCP server test suite or validate.yml.

Acceptance criteria

  • Every skills/*/SKILL.md follows one documented frontmatter convention.
  • CLAUDE.md, AGENTS.md, .cursorrules and CONTRIBUTING.md describe that same convention.
  • CI fails when a skill is missing a required frontmatter field.

Getting started

  • Relevant files: skills/*/SKILL.md, CLAUDE.md, CONTRIBUTING.md
  • How to run tests: cd mcp-server && pip install -r requirements-dev.txt && python -m pytest
  • Related docs: Developer-Tools-Directory standards/skills.md

Related: #48, #61


Filed by repo-audit/fix-issues at e061709. Severity: low. Effort: M. audit-key: tech-debt|skills/state-bags/SKILL.md|frontmatter-standard

Vorherrschende Sprache
Python
Sterne
7
Forks
4
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Entwicklungsumgebung

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus TMHSDigital/CFX-Developer-Tools

Alle Issues in TMHSDigital/CFX-Developer-Tools

Ähnliche Issues

Weitere Issues zu Python

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.