Skip to content

Commit 978fe38

Browse files
committed
v1.2.1 — rename template/SKILL.md to template/TEMPLATE.md
The skills.sh CLI globs **/SKILL.md across the repo when discovering installable skills, so the template was appearing as a second skill candidate ("your-skill-name") in the npx skills add picker. Renaming the template avoids the glob while keeping the starter content discoverable to contributors. Also rewrote the template body to make it self-documenting — explains why the file is named TEMPLATE.md, how to use it (copy the inner SKILL.md block into your new skills/<name>/ folder), and links to related docs. - git mv template/SKILL.md template/TEMPLATE.md - .github/workflows/lint.yml: required-files check now expects template/TEMPLATE.md - README.md: file tree updated; note about naming added - .claude-plugin/marketplace.json: v1.2.1 - skills/design-engineering/SKILL.md: frontmatter version 1.2.1 - CHANGELOG.md: v1.2.1 entry
1 parent c89bcc0 commit 978fe38

7 files changed

Lines changed: 77 additions & 50 deletions

File tree

.claude-plugin/marketplace.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
"homepage": "https://github.com/HKTITAN/design-engineering",
1212
"repository": "https://github.com/HKTITAN/design-engineering",
1313
"license": "MIT",
14-
"version": "1.2.0",
14+
"version": "1.2.1",
1515
"plugins": [
1616
{
1717
"name": "design-engineering",

.github/workflows/lint.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ jobs:
6565
"CODE_OF_CONDUCT.md"
6666
"SECURITY.md"
6767
"spec/agent-skills-spec.md"
68-
"template/SKILL.md"
68+
"template/TEMPLATE.md"
6969
".claude-plugin/marketplace.json"
7070
)
7171
for f in "${required[@]}"; do

CHANGELOG.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,14 @@ All notable changes to this skill are recorded here. Format follows [Keep a Chan
44

55
## [Unreleased]
66

7+
## [1.2.1] — 2026-05-22
8+
9+
### Fixed
10+
11+
- `template/SKILL.md` renamed to `template/TEMPLATE.md`. The skills.sh CLI globs `**/SKILL.md` across the repo when discovering installable skills, so the template file was appearing as a second skill candidate (`your-skill-name`) in the install picker. Renaming sidesteps the glob while keeping the starter content discoverable to contributors. ([#install-picker-fix](https://github.com/HKTITAN/design-engineering/commit/v1.2.1))
12+
- `.github/workflows/lint.yml` required-files check updated to reference `template/TEMPLATE.md`.
13+
- README file tree and `marketplace.json` version updated accordingly.
14+
715
## [1.2.0] — 2026-05-21
816

917
Adds two more named sources mirrored offline in `spec/` — the full [Agent Skills specification](https://github.com/agentskills/agentskills) and [Google Labs' design.md format](https://github.com/google-labs-code/design.md) — plus integrates [Agentation](https://www.agentation.com) as both an installer-recommended companion tool and a skill-graph node.
@@ -119,7 +127,8 @@ Initial public release of the `design-engineering` skill graph.
119127
npx skills add HKTITAN/design-engineering
120128
```
121129

122-
[Unreleased]: https://github.com/HKTITAN/design-engineering/compare/v1.2.0...HEAD
130+
[Unreleased]: https://github.com/HKTITAN/design-engineering/compare/v1.2.1...HEAD
131+
[1.2.1]: https://github.com/HKTITAN/design-engineering/compare/v1.2.0...v1.2.1
123132
[1.2.0]: https://github.com/HKTITAN/design-engineering/compare/v1.1.0...v1.2.0
124133
[1.1.0]: https://github.com/HKTITAN/design-engineering/compare/v1.0.0...v1.1.0
125134
[1.0.0]: https://github.com/HKTITAN/design-engineering/releases/tag/v1.0.0

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -140,7 +140,7 @@ design-engineering/
140140
├── spec/
141141
│ └── agent-skills-spec.md ← pointer to the Agent Skills specification
142142
├── template/
143-
│ └── SKILL.md ← starter template for a new skill
143+
│ └── TEMPLATE.md ← starter template (not SKILL.md so the CLI ignores it)
144144
└── skills/design-engineering/
145145
├── SKILL.md ← thin Map of Content (~90 lines)
146146
├── evals/ ← Perplexity Step-0 evals

skills/design-engineering/SKILL.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: Load when reviewing UI code, designing a component or page layout,
44
license: MIT
55
metadata:
66
author: HKTITAN
7-
version: "1.2.0"
7+
version: "1.2.1"
88
graph: true
99
---
1010

template/SKILL.md

Lines changed: 0 additions & 45 deletions
This file was deleted.

template/TEMPLATE.md

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
# Skill template
2+
3+
This file is a starter template for adding a new skill to this repo. It is **deliberately named `TEMPLATE.md` (not `SKILL.md`)** so the [skills.sh](https://skills.sh) CLI does not pick it up as an installable skill.
4+
5+
## How to use this template
6+
7+
1. Decide the new skill's name — lowercase, hyphenated (e.g. `my-new-skill`).
8+
2. Create the folder `skills/<my-new-skill>/`.
9+
3. Copy the SKILL.md template block below into `skills/<my-new-skill>/SKILL.md`.
10+
4. Update the frontmatter — `name` (must match folder), `description` (the "Load when…" line), `metadata.author`.
11+
5. Decide if you're using the skill-graph pattern. If yes → create `references/<theme>/` subfolders and atomic nodes; keep `graph: true`. If no → write all content directly in `SKILL.md`; set `graph: false`; stay under 500 lines per the [agentskills spec](../spec/agent-skills-spec.md).
12+
6. Add an entry to `.claude-plugin/marketplace.json` so the new skill is published as a Claude Code plugin.
13+
7. Add a CI required-files row in `.github/workflows/lint.yml` if you want CI to enforce its presence.
14+
15+
## SKILL.md template
16+
17+
Copy from the next line down through the end of this file into your new `skills/<my-new-skill>/SKILL.md`:
18+
19+
```markdown
20+
---
21+
name: my-new-skill
22+
description: Load when ___. One or two sentences describing the user queries that should trigger this skill. Use real phrasing, not workflow summary. Examples — "designing X", "reviewing Y", "asking Z".
23+
license: MIT
24+
metadata:
25+
author: YOUR_NAME
26+
version: "0.1.0"
27+
graph: false
28+
---
29+
30+
# my-new-skill
31+
32+
## When to use this skill
33+
34+
(Optional — usually the frontmatter description is enough. Add this section only if you want explicit decision-tree guidance for the agent.)
35+
36+
## How to use this skill
37+
38+
(For graph-style skills, this becomes a Map of Content section with wikilinks to atomic nodes.)
39+
40+
## Body
41+
42+
(Replace this section with the actual skill content. Be terse. Every sentence costs tokens in every session.)
43+
44+
## Gotchas
45+
46+
(Append-only list of failure cases. Each entry: `[YYYY-MM-DD] one-line description → fix in [[node-name]]`.)
47+
48+
---
49+
50+
Built following the [Agent Skills specification](https://agentskills.io/specification).
51+
```
52+
53+
## Why TEMPLATE.md not SKILL.md
54+
55+
The `skills.sh` CLI globs `**/SKILL.md` across the repo when discovering installable skills. A file at `template/SKILL.md` would appear in the install picker as a second skill candidate alongside the real one, which is confusing for installers.
56+
57+
Naming this file `TEMPLATE.md` keeps the same starter content available to contributors while avoiding the false-positive in the CLI picker.
58+
59+
## Related
60+
61+
- [`AGENTS.md`](../AGENTS.md) — repo-level conventions when editing skills.
62+
- [`CONTRIBUTING.md`](../CONTRIBUTING.md) — PR conventions, node format, length targets, cross-model testing.
63+
- [`spec/agent-skills-spec.md`](../spec/agent-skills-spec.md) — full Agent Skills specification (offline mirror).

0 commit comments

Comments
 (0)