跳转到内容

贡献指南

本手册只记录供应商公开能力和通用接入方法,不绑定具体通知网关,也不接受真实 Token、Webhook、内部域名、账号截图或生产消息数据。

  1. 在 src/data/channels.json 增加平台和方式元数据,保持 platformId/methodId 唯一。
  2. 在 src/content/docs/channels/{platformId}/ 创建平台概览和独立方式教程。
  3. 方法教程 frontmatter 的 handbook.platformId 与 handbook.methodId 必须和目录一致。
  4. 使用大写占位符编写 curl、JavaScript、Python 示例;所有网络调用设置超时并判断平台业务码。
  5. 运行 npm run verify,确认内容、类型、构建和站内链接全部通过。

通知投递教程应包含准备条件、能力边界、配置步骤、权限判断、Web 控制台或客户端入口、凭据说明、三语言最小请求、验证结果、限制与配额、安全建议、常见问题、官方资料和核验日期。

双向对话教程还应覆盖接收模式、验签或长连接、事件去重、会话键、确定性 API 回复、可选 AI 扩展、超时与异步处理、群聊触发规则以及 Bot 自身消息过滤。

等级使用条件
source-reviewed已逐项核对官方文档,但没有真实账号发送证据
sandbox-verified在平台测试组织或沙箱完成关键路径验证
production-verified有经过脱敏的真实环境验证记录和复核责任人
deprecated平台已公告弃用或教程不再适用于当前接口

论坛、博客和代码仓库可以辅助发现问题,但关键配置、权限和配额必须回到官方资料。无法确认的差异应明确写成“以控制台实际显示为准”,不能推断成确定事实。

  • 修改事实时同步更新 reviewedAt 和官方资料链接。
  • 平台改名、接口迁移或弃用时更新目录状态、正文和替代路径。
  • 如果只修排版或错别字,不要提高验证等级。
  • 外部链接失效时优先寻找同一官方站点的新地址,并在变更记录中说明迁移。
Terminal window
npm ci
npm run verify

提交中应说明修改的平台、依据的官方资料、验证等级是否变化,以及哪些步骤仍未使用真实账号验证。