From 1f0d79a0c657e773d527a4f0f193597f63c59ed8 Mon Sep 17 00:00:00 2001 From: Dominic Griesel Date: Mon, 29 Jun 2026 13:06:44 +0200 Subject: [PATCH] document single-item numbered list normalization in firmware PR review skill --- .claude/skills/firmware-update-pr-review/SKILL.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/.claude/skills/firmware-update-pr-review/SKILL.md b/.claude/skills/firmware-update-pr-review/SKILL.md index 0d84191..252b1ab 100644 --- a/.claude/skills/firmware-update-pr-review/SKILL.md +++ b/.claude/skills/firmware-update-pr-review/SKILL.md @@ -10,6 +10,7 @@ description: Use this skill when reviewing any pull request against the zwave-js PRs that add or modify `firmwares//*.json` often arrive with: - Non-canonical titles (missing vendor, `.json` suffix, unusual phrasing) - Changelogs with stray whitespace or malformed bullets +- Changelogs written as a single numbered list item (`"1. Fixed X"`) — the `1.` prefix is meaningless with only one item - Typos in text fields - Spaces instead of tabs for indentation @@ -136,6 +137,17 @@ So: decide per-file by reading the other (unchanged) changelogs in the same JSON Regardless of the style decision, genuine normalizations (trimmed stray whitespace, fixed malformed bullets, escape-fix for bad markdown) are always worth committing. +#### Single-item numbered lists + +A changelog written as `"1. Some description"` — a single numbered-list item — should have the `1. ` prefix stripped. A list with one entry is just prose; the numbering adds noise without organizational value. + +``` +"1. Original Release Firmware" → "Original Release Firmware" +"1. Fixes latching issue" → "Fixes latching issue" +``` + +Only strip when the changelog contains **exactly one item** — i.e., no `\n` followed by `2.`. Multi-item numbered lists (`"1. ...\n2. ..."`) are valid and must be left unchanged. + #### Splitting prose into bullets Submitters often paste a changelog as a single run-on sentence-stream like `"Fixed X. Optimized Y. Added Z."`. When the prose contains 2+ distinct changes, split it into a bullet list — it renders far better on the consumer side (z-wave-js, Home Assistant, etc.).