plugins/review
2
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fix(frontmatter): 修正 api-doc 技能 SKILL.md frontmatter 的 YAML 純量語法錯誤

Browse Source 
What：
- 修正 skills/api-doc/SKILL.md frontmatter 裡 description 欄位的 YAML 語法錯誤。
- 整串 description 加上單引號，內部撇號改寫成兩個單引號，內容文字一個字都沒變。
- 同步更新 plugin.json、.claude-plugin/plugin.json、.codex-plugin/plugin.json 三個 manifest 版本號，從 0.1.1 進到 0.1.2。

Why：
- description 內含「冒號加空白」，屬於未加引號的 YAML plain scalar，違反 YAML 語法規定。
- Antigravity 解析 frontmatter 時當場中斷，整支技能被靜默丟棄，沒有任何錯誤訊息；磁碟上 34 支技能，Antigravity 只認得 28 支。
- 準則要求 description 用英文撰寫，不能把「: 」改成全形冒號迴避語法問題，只能加引號修正。

How：
- 整串 description 值加上單引號，內部撇號寫成兩個單引號跳脫，其餘字元不動。
- 用 git show HEAD: 取出改前的原始值，把改後的單引號純量還原後做字串相等比對，確認逐字相同、字元數一致。
- 執行 ste100-lint.sh、check-behaviors.sh、lint-frontmatter.sh 三支檢查腳本，退出碼皆為 0；git diff --numstat 顯示只動了 frontmatter 那一行。

Who：
- 本次修到 review 技能組的 api-doc 技能，屬稽核 API 專案 Swagger/OpenAPI 文件的功能。
This commit is contained in:
jiantw83
2026-08-31 19:04:02 +08:00
parent 2e4ce92626
commit 5e7de7a792
4 changed files with 4 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
skills/api-doc/SKILL.md
+1 -1
View File
@@ -1,6 +1,6 @@
---
name: api-doc
description: Audit an API project's Swagger/OpenAPI documentation: every returnable HTTP status code declares a response type, every input and output carries a description, and a real data example sits on scalar members only — a data-model member takes a description and hands the example duty down to its own properties, recursively to the innermost scalar. Run after controller work or an implementation is complete, e.g. from jsc-sdlc implement, next to jsc-review:code-review. Detection runs first via tools/swagger-detect.sh; without both the Swagger package and its wiring, report unsupported and stop. The source comment contract belongs to jsc-review:code-review group 5; this skill covers Swagger document attributes only. Findings carry file:line, severity, and the fix; this skill never modifies code.
description: 'Audit an API project''s Swagger/OpenAPI documentation: every returnable HTTP status code declares a response type, every input and output carries a description, and a real data example sits on scalar members only — a data-model member takes a description and hands the example duty down to its own properties, recursively to the innermost scalar. Run after controller work or an implementation is complete, e.g. from jsc-sdlc implement, next to jsc-review:code-review. Detection runs first via tools/swagger-detect.sh; without both the Swagger package and its wiring, report unsupported and stop. The source comment contract belongs to jsc-review:code-review group 5; this skill covers Swagger document attributes only. Findings carry file:line, severity, and the fix; this skill never modifies code.'
---
# api-doc