提交 Mirv 扩展到官方仓库的 PR 流程
什么时候提交 PR
当你写了一个功能完善、维护稳定的 Mirv 扩展,想分享给更多用户使用时,可以考虑提交到 Mirv 官方扩展仓库。这样所有启用官方仓库的 Mirv 用户都能看到并安装你的扩展。
官方仓库的地址由 Mirv 主仓库管理,具体 URL 请从 Mirv GitHub README 或扩展管理界面里获取。
提交步骤
1. Fork 官方扩展仓库
去 GitHub 找到 Mirv 官方扩展仓库,点击右上角 Fork,把仓库复制到你自己的 GitHub 账号下。
2. 克隆到本地
git clone https://github.com/你的账号/官方扩展仓库.git
3. 创建扩展文件
在仓库的正确目录下(官方扩展仓库一般按 @type 分目录,如 bangumi/、manga/、fikushon/)创建你的扩展 JS 文件:
- 文件名 =
@package的值 +.js; - 内容包含元数据注释块 + Extension 子类;
- 不要包含
index.json文件(这是官方特别说明的)。
4. Commit & Push
git add bangumi/com.example.myext.js
git commit -m "feat: add com.example.myext"
git push origin main
5. 创建 Pull Request
回到你 Fork 的 GitHub 页面,会出现 Compare & pull request 按钮。点击后:
- 标题写清楚扩展名称和功能;
- 描述里写:扩展类型、目标站点地址、测试了什么功能、有没有已知限制;
- 关联 Mirv 主仓库的 Issue(如果有的话)。
PR 审核要点
提交到官方仓库的扩展会经过社区审核,重点看:
- 格式是否正确:@package 和文件名一致、@type 声明正确、元数据完整;
- 功能是否完整:latest + search + detail + watch 四个核心方法都实现了、能正常返回数据;
- 目标站点是否公开合法:不收录侵权或灰产站点;
- 代码质量:不要在扩展里塞不必要的逻辑、命名规范、注释清晰;
- 不会泄漏敏感信息:扩展里不要硬编码 API key、不要记录用户隐私;
- 能正确使用 this.request:不走 fetch、跨域处理正确。
提交被拒了怎么办
被拒通常是因为格式问题、功能不完善或目标站点不适合收录。看审核评论里的具体原因,修改后重新提交就行——PR 流程允许反复修改直到通过。
不提交到官方仓库也可以
如果你的扩展是给自己用的、或只想在小圈子里分享,直接把 JS 文件丢到 Mirv 扩展目录就行,不需要走 PR 流程。