Skip to content

贡献指南

MME Wiki 的内容长期通过 Directus 线上后台维护。游客可以浏览公开条目;普通用户按指南提交线索;受邀成员可以进入后台投稿、维护和参与审核。

可以贡献什么

  • 新增 MME 条目。
  • 修复失效下载地址。
  • 补充作者、别名、标签、依赖、密码说明或预览图。
  • 修正错误备注、重复条目或状态。
  • 反馈后台、前台页面和部署文档问题。

提交 MME 条目

推荐通过前台投稿入口或受邀后台账号提交,不需要直接编辑 JSON。

投稿内容建议包含:

  • MME 名称。
  • 作者或配布者。
  • 下载地址来源。
  • 链接是否已验证可访问。
  • 适用范围、依赖、密码说明或失效说明。
  • 标签和预览图。

当前仓库里的 docs/data/items 是迁移期本地快照。平台化完成后,长期真实数据源是 PostgreSQL,由 Directus 后台维护。

投稿流程

text
提交线索或后台投稿

进入待审核状态

审核员检查来源、链接、图片、标签和备注

信息完整:发布到前台
信息不足:驳回并说明原因

补充后可再次提交

发布后的公开状态只使用:

  • published:可用并公开。
  • checking:需要继续确认。
  • unavailable:暂不可用或失效。

草稿、待审核和归档内容不应开放给游客。

内容规则

  • 不提交来源不明的下载地址。
  • 镜像链接需要说明来源和转载边界。
  • 失效链接不要直接删除,优先标记状态并补充说明。
  • 备注只写必要信息,复杂说明后续可拆成独立页面。
  • slug 是公开稳定标识,发布后不要随名称微调频繁修改。
  • 图片应能帮助识别效果,避免明显无关、侵权或低质量图片。

受邀参与

第一阶段不开放公开注册。需要参与维护时,由管理员在 Directus 后台邀请账号。

text
管理员发送邀请邮件

受邀用户设置密码

默认获得 Member 或 Editor 权限

按权限投稿、维护或进入审核流

角色边界:

  • Public:游客,只能浏览公开内容。
  • Member:受邀普通成员,可以投稿、评分和收藏。
  • Editor:组员维护者,可以补充和修正内容,发布前需要审核。
  • Reviewer:审核员,可以通过或驳回投稿。
  • Admin:管理员,负责用户、权限、内容模型和审核配置。
  • Owner:站长账号,保留最高权限,只给站点所有者和极可信备用人。

维护者发布检查

每次内容发布前,至少确认:

  • 名称、作者、链接、标签和状态字段完整。
  • 没有明显重复或冲突条目。
  • 至少有一个可解释来源的下载或配布链接。
  • 图片能从前台实际加载。
  • 修改原因能从投稿、审核记录或维护记录里追溯。
  • Public 角色只能读取公开状态内容。

迁移期和前台构建检查可运行:

bash
npm install
npm run validate:data
npm run build

线上后台启用后,内容校验和审核规则会逐步迁移到 Directus 权限、字段规则和自动化流程中。

权限变更规则

权限调整遵循最小权限原则:

  1. 新成员先给 MemberEditor 或更低权限。
  2. 确认能稳定维护后,再按需要提升到 Reviewer
  3. Admin 只给需要处理用户、内容模型、审核配置或部署的人。
  4. Owner 只保留站长和极可信备用人。
  5. 成员退出维护后,及时禁用账号或移除高权限角色。

任何权限异常都先回收权限,再查原因。

模型、权限和服务器变更

模型或权限变更前:

  • 先备份 PostgreSQL。
  • 记录修改了哪些集合、字段、关系或角色权限。
  • 优先在低风险时段操作。
  • 操作后检查 PublicMemberEditorReviewerAdmin 的关键权限。

服务器发布前:

  • 本地 npm run build 必须通过。
  • 确认没有把 deploy/.env、备份文件或管理员密码放进仓库。
  • 如果只更新前台静态文件,不动数据库和上传文件。
  • 如果修改 compose.ymlCaddyfile 或环境变量,发布后检查前台、后台、API 和 HTTPS。

事故处理

内容事故按这个顺序处理:

text
暂停相关账号权限

确认影响范围

从投稿、审核记录和 Directus 记录定位变更

能手动修复则修复

不能可靠修复则恢复数据库备份

复查前台公开内容

服务器不可用时按层级排查:

text
域名 / HTTPS

Caddy

前台静态文件

Directus

PostgreSQL

上传文件 volume

事故处理中不要继续做新的批量修改,避免扩大影响。

例行检查

每周建议检查:

  • 首页、Wiki 列表、贡献者页和团队页是否能正常打开。
  • 后台是否能登录。
  • 最近新增或修改的条目是否显示正确。
  • 投稿队列是否有积压。
  • 失效链接反馈是否已处理。
  • 数据库备份和上传文件备份是否成功生成。

每月建议检查:

  • 管理员、审核员和组员账号是否仍需要保留权限。
  • Public 角色是否仍只读取公开状态内容。
  • Directus、PostgreSQL、Caddy 镜像是否需要升级。
  • 服务器磁盘空间是否充足,尤其是上传文件和备份目录。
  • 是否需要把旧备份转移到异地存储。

内容由社区通过线上投稿和维护者审核共同维护。