贡献指南
欢迎提交 Issue 和范围清晰的 PR。完整指南在仓库里:
在 GitHub Issues 提交,包含:复现步骤、期望行为 vs 实际行为、环境信息(Node 版本、OS、脱敏后的 .knowflowrc 关键配置)。
- Fork 并建分支(
git checkout -b feature/amazing) - Conventional Commits(
feat:、fix:、docs:…) - 确保
npm run check和npm test通过
代码规范:Shell 用 set -euo pipefail,Node 用 ES Modules,Python 3.10+ 带类型注解。
贡献 Wiki 页面
Section titled “贡献 Wiki 页面”除了代码还可以贡献知识 —— 对好文章跑一次 knowflow ingest,再让你的编码 agent 按合成契约合成。合成页以 status: pending 落地,等维护者审核。
给 AI 助手的速查表
Section titled “给 AI 助手的速查表”如果你是正在参与这个仓库的 AI 助手,这张表是给你的:
| 你想做什么 | 看哪里 |
|---|---|
| 理解整体架构 | 系统架构 |
| 理解方法论 | 方法论 |
| 理解数据格式 | 数据模型 |
| 从 raw 素材合成 wiki 页面 | docs/agents/synthesize.md |
| 改采集逻辑 | scripts/ingest.sh |
| 改模板 | templates/*.md |
| 改 CLI 命令 | bin/knowflow.js |
| 改图谱构建 | scripts/graph_builder.py |
| 改向量检索 | scripts/vector-store.mjs |
KnowFlow 是知识编译器,不是搜索工具。价值链:
原始素材 → [任一 agent,同一份合成契约] → 待审 Wiki → [你的审核] → 互联 Wiki → [关联] → 图谱 + 可选向量索引