参与贡献——报告纠错或提名板卡
如何报告 MCUID 上的错误事实(附证据模板)、如何提名新板卡进入收录、提交之后会发生什么、什么样的报告可以被执行。
MCUID 用单一硬件事实库渲染双语页面,每个发布字段都固定到读取它的官方文档。欢迎纠错与提名新板——本页说明要发送什么,报告才能不经反复猜测直接被处理。
报告纠错
复制下面的模板,逐行填写,通过本页底部公布的渠道提交。
1. 页面与位置:
URL:<页面地址,以及你报告的表格行 / 章节 / 字段>
2. 板卡与修订:
<板上丝印的板卡名称,以及你知道的 PCB 修订>
3. 错在哪里:
<原字段或原句,以及它应该是什么>
4. 官方来源 / 证据:
<文档标题、版本/日期、章节、表格或图——公开文档附链接>
5. 转载许可(如果你粘贴文字或图片):
<如"仅引用并附链接" / "CC-BY-SA 来源,已署名" / "我自己的照片">可执行的报告——示例(真实形态,取自一次实际评审发现):
- URL:
/zh/boards/raspberry/pico-w/——claims 表gpio25.board_use。- Raspberry Pi Pico W,v1。
- 页面曾写 GP25 "板上未用";SDK 板级头文件定义
CYW43_DEFAULT_PIN_WL_CS 25——GP25 是无线 SPI 片选,不是未用。- pico-sdk @ 079c6f39(tag 2.3.1)
src/boards/include/boards/pico_w.h——链接附后。- 仅引用并附链接。
无法执行的报告——示例:
"C6 针表错了,GPIO 编号看着不对。"——没有页面、没有行、没有来源、没有期望值。
第一份可以对照所引文档核查,一轮就能合并或答复;第二份不行:我们不会去猜 200+ 个触点里指哪个,也不会在没有来源的情况下改动已发布事实。
提名板卡
板卡在官方文档可链接、可固定时进入 MCUID——每个关键事实都要有:身份、排针/引脚图、供电与启动行为、开发入口。使用此模板:
1. 板卡:<官方全名,厂商>
2. 为什么适合收录:<哪些开发者需要它、做什么任务>
3. 你知道的官方文档:
- 板卡用户指南 / 数据手册:<URL + 可见版本>
- 引脚图:<URL>
- SDK 板级定义(如有):<仓库 + 文件>
4. 修订 / 变体:<你所知道的——"不知道"是可以接受的答案>
5. 特殊之处:<已知陷阱、strapping 引脚、修订差异>回答"不知道"完全没问题——在 MCUID 上"未知"是合法状态,会被如实标注而不是被猜测。我们无法接受的是没有可链接官方文档的板卡:不会为它们生成占位页(见关于)。
提交之后会发生什么
- 受理——报告连同其来源链接一起登记。
- 核对——每条断言对照所引文档验证;缺证据时一次性补要,并明确指出缺什么。
- 合并或驳回——合并的事实把你引用的来源带进数据记录;驳回的报告给出简短理由(通常是:来源不是这个意思,或只适用于其他修订/板卡)。
- 回告——处理结果经报告到达的渠道发回。
提交渠道
公开接收渠道正在建立中。项目代码仓库当前不接受匿名 issue 报告(其 issue 跟踪器不可公开访问——2026-11-12 实测),在本页公布常设渠道之前,本页本身就是受理标准的说明:上方模板、四步处理流程、以及关于页的收录门槛。当存在确认可用、有明确接收人的渠道后,将列在本节。
贡献的写作标准
- 事实必须带固定来源(文档 + 版本 + 章节)——"我记得不是这样"是线索,不是事实。
- 按修订区分的事实要写明修订;v1.0 的事实不得静默套用到 v1.1。
- 引用就是引用,不得改写成新断言;转载的文字/图片注明许可。
- 两种语言、一个事实库:任一语言提交均可;站点保持两个语言版本一致。