Skip to content

参与贡献

感谢你愿意花时间改进 Regulus。无论你是开发者还是领域专家,都有适合的贡献方式。

你可以做什么

方向适合谁入口
知识节点领域专家、不写代码的协作者编写 regulus-coach/domains/ 下的节点 YAML
教练与前端Go / TypeScript 开发者internal/agent/web/src/
Prompt熟悉 LLM 教学编排的人regulus-coach/prompts/
Obsidian / 笔记设计知识库用户、信息架构见下文「知识沉淀 · Obsidian 导出」
体验反馈所有用户GitHub [体验] Issue
文档愿意改说明的人本仓库 apps/docs/ 或 README

当前特别欢迎:知识图谱体验优化、节点教考对齐、新知识域(Python / Agent / Docker 等)、Obsidian 学习笔记导出设计(见下文)。

知识沉淀 · Obsidian 导出(欢迎设计贡献)

导出学习笔记 的 MVP 已上线:节点点亮 → 异步蒸馏 → 导出 zip → Obsidian 打开。当前实现刻意从简——基础 frontmatter、_MOC.md、wikilink、蒸馏正文,能跑通闭环,但离「愿意每天打开复习」还有距离。

Obsidian 学习笔记预览

如果你常用 Obsidian、Logseq 或 Markdown 知识库,这里可能是高性价比的贡献方向:不一定要写 Go,可以先交设计稿或样例 vault。

现状(MVP)

已有尚未做
节点点亮后 LLM 蒸馏笔记(phase_note_distill.md闪卡 / 间隔复习格式
按课程导出 zip,中文文件名 + wikilink多课程合并为一个 vault
_MOC.md 按掌握深度列表Dataview 查询模板、标签体系
frontmatter:domain / layer / mastery / status跨域笔记自动建链
无笔记时的占位(关键概念、踩坑)Agent 维护笔记、RAG 反哺教练

代码入口:internal/domain/export_vault.gointernal/agent/note_distill.go。设计草案:docs/knowledge-vault.md

欢迎贡献什么

  • 笔记模板:frontmatter 字段、正文结构(复习友好、可扫读)
  • MOC / 索引页:按模块分组、掌握度视图、待复习清单
  • 蒸馏 Promptregulus-coach/prompts/phase_note_distill.md 怎样写更像「自己的笔记」
  • 导出组装export_vault.go 的链接策略、文件名、附件结构
  • Obsidian 生态:兼容 Dataview、Spaced Repetition、Templater 等的约定与示例

怎么参与

  1. 导出一份 自己的 vault,在 Obsidian 里试用
  2. 开 GitHub Issue,标签建议 [讨论],附上:痛点、理想样例(可贴 .md 片段或截图)
  3. 若已有具体改动,PR 欢迎;纯设计讨论也欢迎,先对齐再写代码

用户向说明:导出学习笔记 · 界面截图:界面预览

协作流程

  1. Fork 仓库,从 main 拉分支
  2. 本地按 本地开发 跑通
  3. 提交 PR,说明改动动机;关联 Issue 请写 Fixes #123
  4. 遵守 行为准则

完整手册(项目结构、节点 YAML 格式、PR 检查清单):CONTRIBUTING.md

教学质量相关

若你关心「练太多 / 一点就亮」「节点边界模糊」等教学体验,请先读 贡献 · 教学质量,再开 [讨论][体验] Issue 对齐预期。

相关