用途:在使用 TomTom Maps SDK for JavaScript(@tomtom-org/maps-sdk)开发过程中遇到文档不清、API 无法表达目标或功能损坏等问题时,把摩擦整理为可操作的反馈报告,提交至公开仓库 tomtom-international/maps-sdk-js。
主要能力与流程:
- 同意机制:报告会关联开发者 GitHub 身份和项目内容,涉及 GDPR。首次涉及 SDK 时以纯文本询问一次,可选 yes、ask each time、no;未明确同意不发送。开发者可随时撤回;撤回后丢弃已收集内容。
- 收集:在问题发生当下记录目标、首次尝试及指向它的文档或示例、每次尝试与逐字错误、最终可用代码与差异、SDK 版本与入口点(/map、/services、/core 或插件)、平台与框架,以及可见时的界面状态。不在开发者项目中创建跟踪文件。
- 查重:发现项达标后即检索公开仓库的 open issue 与 discussion,使用 gh search issues、gh api graphql 等命令;无登录 gh 时给出浏览器检索链接。命中相同根因则不发新报告,或仅补充差异评论。
- 发布时机与路由:功能可用或开发者收尾时执行,非任务中途;每个根因一份报告。可复现的 broken 走 issue(bug_report.yml,标签 bug);showcase-mismatch 走 issue(标签 bug、documentation);unclear、cannot-express 等走 discussion 的 ideas 类;无法判断是否支持则走 q-a 类提问。
- 起草与发布:按 posting.md 模板写入 $TMPDIR/feedback-draft.md,脱敏后向开发者展示完整标题、正文、截图、目的地与方式,仅在明确同意后发布。截图保存为 $TMPDIR/feedback-<n>.png,裁剪至问题区域,不含地址栏、开发者工具、个人数据或真实位置。
- 报告风格:整句、现在时、主动语态、事实性语气;正文不超过约 400 词,代码片段不超过 30 行,尝试表最多 5 行,截图最多 3 张。
适用场景:使用该 SDK 开发时遇到文档、API 能力或缺陷类摩擦,且希望反馈给官方团队。
限制:仅面向该 SDK 仓库;必须获得明确同意,无法在未批准时发送;删除已发布报告需由仓库维护者处理,可代为提交删除请求或按隐私声明联系 TomTom。其余细节如具体模板内容、脱敏清单以仓库文档为准。