参与社区
NotionNext 已由个人仓库移交至组织 notionnext-org,欢迎既是站长又是开发者的参与者一起维护代码与文档。所有参与代码、主题、文档、Issue、Review 与发布维护的贡献者,都会在 致谢页 与 GitHub 贡献记录中被看见。
四步参与路径
text
1. 使用站点 / 读文档
↓
2. 提问(Discussions 或 Issue)
↓
3. 贡献(文档 PR 或代码 PR)
↓
4. 成为维护者(可选,认领负责域)1. 使用与阅读
- 在线文档:notionnext.tangly1024.com
- 快速开始:介绍 → Vercel 部署
- 旧版 Notion 教程:docs.tangly1024.com(历史截图)
2. 提问与讨论
| 场景 | 去哪里 |
|---|---|
| 部署/配置「怎么用」 | GitHub Discussions · 使用问答 |
| 某篇教程不清楚 | 该页底部 文档反馈(Giscus)或 Discussions · 文档 |
| 确认是 Bug | Bug Report Issue |
| 功能想法 | 先在 Discussions · 想法 对齐,再开 Issue |
技术问题优先 GitHub,便于搜索与志愿者接手。微信群/Telegram 见 交流社群(非官方 SLA)。
3. 报告 Bug 与 AI Agent 修复
报告 Bug 时,优先把三件事写清楚:
- 实际现象:现在页面或功能发生了什么。
- 期望现象:正常情况下应该是什么结果。
- 复现步骤:从哪个页面开始,点击什么,刷新或切换什么,最终如何触发问题。
如果问题已经能稳定复现,可以尝试交给 AI Agent 辅助修复,例如 Codex、Cursor、Claude Code、WorkBuddy 或其他支持自动读代码、改代码、提交 PR 的工具。NotionNext 仓库已经内置较多适合 AI 阅读的开发文档、维护手册和文档站 AI 助手指令,AI Agent 可以比较快地接入项目上下文。
推荐工作流:
- 在 Issue 中整理实际现象、期望现象和复现步骤。
- 让 AI Agent 先阅读
docs/developer/、docs/user-guide/中相关页面,以及仓库里的维护手册。 - 要求 AI Agent 从最新
main创建独立分支,不要在自己的站点分支上直接改。 - 让 AI Agent 先定位根因,再做最小修复,不要顺手重构或改个人配置。
- 跑最小必要检查,把命令和结果写进 PR。
- 提交 PR 后,在原 Issue 回复 PR 链接和验证结论。
可参考提示词:
text
根据我的 Bug 描述,创建一个新分支修复这个问题,然后提交 PR 到云端仓库。
要求:
1. 只修复这个 Bug,不要混入我自己站点的个性化配置或无关改动。
2. 在能修复相同问题的前提下,尽量改动最少的代码,降低对其他用户的影响。
3. 修复前先阅读项目内置的开发文档、维护手册和相关主题文档。
4. 保留必要的本地检查结果,并在 PR 描述中说明改动范围、风险和验证步骤。4. 第一次贡献(推荐从文档开始)
- Fork notionnext-org/NotionNext
- 编辑
docs/user-guide/**/*.md(或修复带good first issue的 Issue) - 本地预览:
yarn docs:site:dev - 按 CONTRIBUTING.zh-CN.md 提 PR
改代码 / 主题:阅读 开发者文档(GitHub) · 贡献指南 · 大改动先写 RFC(GitHub)
5. 成为维护者与加入组织
- 完成 1~2 个合并 PR 后,在 Discussions 自荐负责域(文档 / CI / 某主题等)
- 规则见 GOVERNANCE.zh-CN.md · 名单 MAINTAINERS.md
已符合条件但未被邀请?
若你已满足组织协作的合并 PR 等条件,却尚未收到组织邀请,请到 GitHub Discussions 发帖(可选用「组织成员申请」模板),标题写 组织成员申请,并附上 GitHub 用户名、已合并 PR 链接与希望负责的域。维护者会在讨论区按队列回复,邀请可能有延迟。
行为与治理
当前最需要帮助的事
在仓库 Issues 中筛选 good first issue 与 help wanted,常见包括:
- 文档迁移、错别字与 4.9.x 配置说明同步
- 单主题说明或截图更新
- 翻译与
lib/lang补充
维护者会在 Discussions 置顶「欢迎贡献」帖;草稿见 PINNED_DISCUSSION_POSTS.zh-CN.md。
