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

Đang mở
#79 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
3/5
Thời gian dự kiến
1-2 ngày
Mức phù hợp với người mới
45/100
Loại issue
Tài liệu
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
markdown, python, yaml
Lĩnh vực
documentation, tooling

Hướng nghiên cứu

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.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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

Ngôn ngữ chính
Python
Star
7
Fork
4
Chỉ số merge pull request
Không có pull request nào được merge trong 30 ngày

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của TMHSDigital/CFX-Developer-Tools

Tất cả issue của TMHSDigital/CFX-Developer-Tools

Issue tương tự

Thêm issue về Python

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.