Skip to content

Commit 77efcb2

Browse files
committed
fix: clarify skills frontmatter contract and AGENTS sections
1 parent 4e4906e commit 77efcb2

File tree

5 files changed

+7
-6
lines changed

5 files changed

+7
-6
lines changed

.github/workflows/scripts/create-release-packages.ps1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -207,7 +207,7 @@ agent: $basename
207207
#
208208
# Technical debt note:
209209
# Keep SKILL.md frontmatter aligned with `install_ai_skills()` and extension
210-
# overrides (at minimum: name/description/compatibility/metadata.source).
210+
# overrides (at minimum: name/description/compatibility/metadata.{author,source}).
211211
function New-Skills {
212212
param(
213213
[string]$SkillsDir,

.github/workflows/scripts/create-release-packages.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ EOF
127127
#
128128
# Technical debt note:
129129
# Keep SKILL.md frontmatter aligned with `install_ai_skills()` and extension
130-
# overrides (at minimum: name/description/compatibility/metadata.source).
130+
# overrides (at minimum: name/description/compatibility/metadata.{author,source}).
131131
create_skills() {
132132
local skills_dir="$1"
133133
local script_variant="$2"

AGENTS.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -379,8 +379,9 @@ Command content with {SCRIPT} and {{args}} placeholders.
379379
## Directory Conventions
380380

381381
- **CLI agents**: Usually `.<agent-name>/commands/`
382-
- **Common prompt-based exceptions**:
382+
- **Skills-based exceptions**:
383383
- Codex: `.agents/skills/` (skills, invoked as `$speckit-<command>`)
384+
- **Prompt-based exceptions**:
384385
- Kiro CLI: `.kiro/prompts/`
385386
- Pi: `.pi/prompts/`
386387
- **IDE agents**: Follow IDE-specific patterns:

src/specify_cli/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1225,7 +1225,7 @@ def load_init_options(project_path: Path) -> dict[str, Any]:
12251225
# 2) `install_ai_skills()` which converts extracted command templates to skills,
12261226
# 3) extension/preset overrides via `agents.CommandRegistrar.render_skill_command()`.
12271227
# - Keep the skills frontmatter schema aligned across all generators
1228-
# (at minimum: name/description/compatibility/metadata.source).
1228+
# (at minimum: name/description/compatibility/metadata.{author,source}).
12291229
# - When adding fields here, update the release scripts and override writers too.
12301230
NATIVE_SKILLS_AGENTS = {"codex", "kimi"}
12311231

src/specify_cli/agents.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -302,8 +302,8 @@ def render_skill_command(
302302
Technical debt note:
303303
Spec-kit currently has multiple SKILL.md generators (template packaging,
304304
init-time conversion, and extension/preset overrides). Keep the skill
305-
frontmatter keys aligned (name/description/compatibility/metadata) to
306-
avoid drift across agents.
305+
frontmatter keys aligned (name/description/compatibility/metadata, with
306+
metadata.author and metadata.source subkeys) to avoid drift across agents.
307307
"""
308308
if not isinstance(frontmatter, dict):
309309
frontmatter = {}

0 commit comments

Comments
 (0)