用途:为 Maps SDK 的 PR 撰写、改写或精简标题与正文。许多 PR 处于堆叠(stack)中,审阅者可能只看其中一个,因此正文需先说明问题,再给出答案形态,最后带链接走读 diff,而不是写成变更日志。前置技能 tomtom-maps-sdk-js-preflight 先运行并提出标题,本技能负责正文。
主要能力:主张紧凑技术化写作。正文以条目、表格、代码块和图表承载事实,避免段落复述表格;每条目一个要点、一行长,深入时嵌套两级、不超两级;每节最多一句框定语;用加粗 1-3 个词突出扫描重点。给出各部分字数上限(如问题陈述约 5 条加证据表、方案概览约 5 条、diff 节按需展开、注意事项 3-5 条等),并要求只描述当前 SHA 的状态,最后通读删减约五分之一。
使用方式:标题遵循 Conventional Commit 格式 type(scope): subject,scope 为工作区名;含破坏性公开变更时在冒号前加 !;标题含主题行不超过 80 字符(commisery 默认规则 C014,本仓库无 .commisery.yml 覆盖)。可用 gh pr edit <n> --title '…' 修正标题。正文节序固定:顶行(有 stack 或 ticket 时)、## Problem Statement、## Solution Overview、按机制的 diff 节、Screenshots、Breaking changes(表格 Was/Is now/Why)、Tests、Open items、## Caveats、## Next steps、署名页脚。链接优先,Jira 键来自分支或提交信息且不可编造;文件名提及一律链接到 Files changed 标签页的 diff 锚点(diff- 加路径 SHA-256),不指向 blob。提供命令:gh pr view <n> --json files --jq '.files[].path' | while read -r filePath; do printf '%s\tdiff-%s\n' "$filePath" "$(printf '%s' "$filePath" | shasum -a 256 | cut -d' ' -f1)"; done,以及 gh pr view <n> --json files --jq '.files[] | "(.additions + .deletions)\t(.path)"' | sort -rn。可用 mermaid 图,标签需加引号、避免 #、用 </> 与 <br/>;本地无法渲染,需人工检查围栏并说明图未经证实。截图通过 head SHA 加 ?raw=true 嵌入。
适用场景与限制:适用于本仓库贡献者撰写 PR 文案,需遵守其节序、预算与证据标准;不涉及用 SDK 构建应用。本资料未提供收费、价格、平台或效果等信息。