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

未关闭
#79 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
3/5
预计耗时
1-2 天
新手友好度
45/100
Issue 类型
文档
描述清晰度
描述清楚
活跃度
活跃
技术栈
markdown, python, yaml

调研方向

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.

由索引模型根据 Issue 内容生成。

描述

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

主要语言
Python
星标
7
派生
4
PR 合并指标
30 天内没有已合并 PR

环境准备

  • 没有 Dockerfile 或 Docker Compose 文件
  • 没有 Pull Request 模板
  • 阅读贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

TMHSDigital/CFX-Developer-Tools 的其他 Issue

查看 TMHSDigital/CFX-Developer-Tools 的全部 Issue

相似的 Issue

更多 Python Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。