Skip to content

CONTRIBUTING.zh-CN.md

Latest commit

 

History

History
105 lines (72 loc) · 4.28 KB

CONTRIBUTING.zh-CN.md

File metadata and controls

105 lines (72 loc) · 4.28 KB

贡献指南（中文）

感谢你愿意为 NotionNext 做贡献！

仓库与组织

本仓库已由个人账号托管转为 GitHub 组织 notionnext-org 管理，canonical 地址为：

https://github.com/notionnext-org/NotionNext

若你希望参与长期维护、CI 或组织内协作，可先按 参与社区 贡献 PR 并自荐。欢迎加入组织，与维护者一起推进项目。

已符合加入条件但未被邀请？ 请在 GitHub Discussions 留言（标题：组织成员申请），附上用户名与已合并 PR 链接；勿重复私信。详见 GOVERNANCE.zh-CN.md。

若你仍在使用转让前克隆的本地仓库，建议将默认远端改为组织地址，避免长期依赖旧 URL 重定向：

git remote set-url origin https://github.com/notionnext-org/NotionNext.git
git remote -v

Fork 开发与向 main 提 PR 的流程不变；PR 的目标仓库请选择 notionnext-org/NotionNext。

第一次贡献（推荐路径）

  1. 在 Issues 挑选带 good first issue 的任务，或修正你正在阅读的文档页。
  2. 文档改动：编辑 docs/user-guide/**/*.md，yarn docs:site:dev 预览，提 PR。详见 参与维护在线文档。
  3. 代码改动：独立分支 → yarn lint / yarn type-check / 必要测试 → PR。
  4. 大功能或公共 API：先读 RFC 指南 或在 Discussions 对齐。
  5. 长期维护：见 参与社区 与 MAINTAINERS.md。

环境准备

请按以下流程参与开发：

  1. 在 GitHub 上 Fork 仓库。
  2. 克隆到本地（或使用 Codespaces）。
  3. 为本次任务创建独立分支。
  4. 完成功能或修复并本地验证。
  5. 提交并推送分支。
  6. 发起 PR 到 NotionNext 的 main 分支。

常用命令：

  • yarn：安装依赖
  • yarn dev：本地开发
  • yarn build：生产构建
  • yarn start：生产模式运行

必须遵守的协作规则

  1. 每个任务使用独立分支，禁止直接提交到 main。
  2. PR 保持聚焦，避免把无关重构混在一起。
  3. 不要提交个人本地文件（如 .env.local）。
  4. 不要提交会影响他人的个性化默认配置。
  5. 提交前至少执行 lint / type-check / 必要测试（合并前 CI 会自动跑同样检查）。

维护者与高频贡献者请阅读 维护与变更尺度（共识），避免大范围、难回滚的改动影响主线稳定。

更多文档导航：

新建主题

如果要贡献新主题，请以 themes/example 为基础复制一个新目录，目录名即主题 key。

新增语言

如需新增本地化语言：

  1. 复制 lib/lang/en-US.js 并按语言代码重命名（如 zh-CN.js）。
  2. 完成文本翻译。
  3. 在 lib/lang.js 注册该语言。
  4. 提交 PR。

环境变量

  1. 复制 .env.example 为 .env.local。
  2. 按需填写配置。
  3. 不要提交 .env.local。

社区与治理

配置优先级：

  1. Notion 配置表（最高）
  2. 环境变量
  3. blog.config.js（最低）