Skip to content

维护者运行手册(低负担)

English summary

面向 Maintainer / Triager / Founder:用规则与自动化减少重复劳动,把 Founder 精力集中在高影响变更与发版。

1. 设计原则

原则做法
公开优先使用类问题 → Discussions;可跟踪缺陷 → Issue
机器先行CI、Labeler、Dependabot、Stale 处理常规事务
域内自治docs/user-guide/**、单主题目录 PR 由文档/主题维护者合并
守门聚焦Founder 主要 Review CODEOWNERS 路径(lib/dbnext.config.jspackage.json 等)

2. 每周约 15 分钟(Maintainer)

  1. 浏览 Discussions组织成员申请、未回复的「使用问答」。
  2. 扫一眼 Dependabot PR(可批量合并 patch/dev 依赖)。
  3. 合并队列:优先 documentation / good first issueCI 全绿 的 PR。
  4. 仅在发版窗口处理 package.json 版本与 changelog

Founder 可跳过第 3 步中纯文档 PR(若已授权文档维护者)。

3. Issue / Discussion 分流

用户诉求动作管理者耗时
「怎么部署/配置」转 Discussions,关 Issue 或贴链接1 条评论
重复 Issue关为 duplicate,链到已有1 条评论
缺版本/环境信息bug 模板 要求补全,标 needs-info1 条评论
长期无回复交给 Stale bot(45+14 天)0
安全漏洞转 Private Advisory,公开讨论按 SECURITY.md

4. PR 合并权限(建议)

PR 类型标签/路径谁合并CI 要求
纯文档documentationdocs/**任一 Write 维护者docs-site job
单主题themethemes/<name>/**主题维护者或 Writelint + test
依赖机器人dependencies维护者批量CI 绿
核心 / 配置coreconfig、CODEOWNERSFounder 或 2 人 Review全部 job

禁止:未跑 CI 合并、Contributor 自合并自己的 PR(除非维护者明确授权)。

5. 自动化一览

工具作用
ci.ymlPR:lint、type-check、test、lockfile、文档构建
labeler.yml按路径打 documentation / theme / core 等标签
dependabot.yml每周依赖 PR(默认跳过 major)
stale.yml45 天无活动标 stale,14 天后关闭 Issue
deploy-docs-site.ymlmain 文档自动发布
CODEOWNERS仅高影响路径 @Founder

6. Org Admin 一次性设置(合规 + 省力)

GOVERNANCE.zh-CN.md 基础上建议:

  • [ ] Require status checksLint & type-checkUnit testsLockfile consistency(文档 PR 可加 VitePress build
  • [ ] Require PRmain(Founder 亦走 PR,紧急 hotfix 例外并公告)
  • [ ] Allow auto-merge(可选):仅对 CI 绿且仅改 docs/** 的 PR 启用
  • [ ] Secret scanning + Dependabot alerts 开启
  • [ ] 仓库标签与 labeler.yml 一致:documentationthemecoreconfigdependenciesstaleneeds-infogood first issuehelp wanted
  • [ ] Issue 模板默认 assign 给 Founder(已移除 assignees

7. 发版(低频)

  1. 确认 main CI 绿。
  2. 更新 docs/user-guide/changelog/latest.md
  3. 由 Org Admin 打 tag / Release,或运行 bump-version-on-main(仅维护者)。
  4. Discussion 公告 一条即可。

8. 相关文档