如何参与这个开源项目？My-Brain-Is-Full-Crew贡献指南与社区生态

如何参与这个开源项目？My-Brain-Is-Full-Crew贡献指南与社区生态

【免费下载链接】My-Brain-Is-Full-CrewBuilt by a PhD whose memory was failing, whose diet was a mess, and whose anxiety had its own agenda. Most second brain tools ignore the fact that your brain doesn't work in isolation: your body and your mental health are part of the system too. This crew handles all three: knowledge, nutrition, and mental wellness.项目地址: https://gitcode.com/gh_mirrors/my/My-Brain-Is-Full-Crew

My-Brain-Is-Full-Crew 是一个由8 个 AI 智能体 + 14 个专业技能组成的开源第二大脑系统，专为 Obsidian 知识库管理、知识整理与心理健康场景打造。无论你是会写代码的工程师，还是只会用聊天软件的普通用户，都有适合自己的参与方式。这份完整的贡献指南将带你从"零经验"走到"被合并的第一个 PR"。

🧭 项目速览：你正在参与的"AI 船员"

在动手之前，先花 30 秒理解这个项目的结构，能让你精准找到自己最擅长的贡献切入点：

💡 核心理念：源码只有一份，平台有四份。所有智能体都用平台无关的中立格式编写，构建系统再翻译成各平台的原生格式。这也是它最值得改进的地方。

🚀 六种参与方式：总有一种适合你

项目维护者在 README.md 中明确写道："每一个 PR 都受欢迎，我绝不护犊子。"官方贡献规范全部记录在 CONTRIBUTING.md 中，下面逐一拆解。

1️⃣ 改进现有智能体（门槛最低）

发现某个智能体行为怪异、结果不好、或漏掉了边界情况？这是新手最友好的切入点：

• 智能体源码就在 agents/architect.md、agents/scribe.md 等文件中，本质上是带 YAML 头部的 Markdown 文件，改提示词即可；
• 先开一个 Issue 描述问题（附具体例子），或直接在 PR 中提交改进。

改进后的本地验证方法很简单：用 scripts/launchme.sh 构建并安装到一个测试库（vault）中，实际对话测试即可。

2️⃣ 提议一位新的"核心船员"

如果你有一个所有人都需要的新智能体想法（注意：普通用户可以在自己的库里说"create a new agent"自行创建，这里指的是随项目一起发布的核心智能体），请按以下清单开 Issue：

1. 名称：英文描述名 + 简短代号
2. 角色：它解决什么问题？
3. 触发词：何时激活？（多语言短语更佳）
4. 工具权限：需要哪些能力（读、写、编辑、Bash、Glob、Grep）
5. 库集成：读写哪些文件夹？（必须用{{inbox}}等路径令牌，禁止硬编码文件夹名）
6. 协作关系：应与哪些智能体链式协作？
7. 为什么重要：它填补了当前船员的什么空缺？

3️⃣ 添加真实使用案例

真实用户的用法对所有人都是宝藏！把你独特的使用场景写进 docs/examples.md，或直接分享在 Issue 里。不需要技术背景，讲清楚"我说了什么、发生了什么"即可。

4️⃣ 报告 Bug

一个合格的 Bug 报告包含四要素：

• 你让智能体做什么
• 它实际做了什么
• 你期望它做什么
• 相关时附上你的库结构（大致即可）

5️⃣ 为文档与多语言添砖加瓦

项目用英语编写但自动用你的语言回复。description字段鼓励加入多语言触发短语（英、意、法、西、德、葡），熟悉小语种的你可以在智能体描述中补充自然的触发词。入门流程文档见 docs/getting-started.md，每个智能体还有独立详解（如 docs/agents/librarian.md）。

6️⃣ 贡献平台适配器（硬核方向）

想让 Crew 支持新的 Agent 平台？架构是"单一事实源 + 每平台适配器"：每个适配器是 adapters/ 下的一个adapter.sh，实现 7 个adapter_translate_*函数即可。参考实现可看 Claude Code 与 Gemini CLI 的适配器；公共解析工具都在 adapters/lib.sh 中。完成后别忘了在 tests/adapters/ 下补上对应测试。

✅ 首次贡献快速上手（三步走）

第一步：克隆仓库

git clone https://gitcode.com/gh_mirrors/my/My-Brain-Is-Full-Crew

第二步：了解路由机制

通读 DISPATCHER.md —— 调度器是整个系统的"总机"，它先检查技能路由表、再落到智能体路由表，理解了它你就理解了全部。

第三步：提交前跑测试

• 改了适配器 → 跑对应适配器的单元测试
• 改了adapters/lib.sh→ 跑全部适配器测试
• 改了智能体/技能/钩子/调度器 → 跑 tests/regression/run.sh 回归快照比对
• 提 PR 之前：全跑一遍

🌱 社区生态：协作如何发生

智能体之间的协作正是这个项目的精髓，也是贡献者必须遵循的规范：

• 链式协作协议：每个智能体在输出中通过### Suggested next agent段落"推荐下一位同事"，由调度器自动串联。完整协议见 references/agent-orchestration.md，全体船员名录见 references/agents-registry.md；
• 平台无关钩子：hooks/protect-system-files.sh 保护核心文件不被误改，新增钩子需同时提供.hook.yaml元数据与读取中性 JSON 的.sh脚本；
• 自定义 vs 核心：你在自己库里创建的自定义智能体优先级低于核心船员；如果你的自定义智能体能帮到很多人，官方鼓励你把它"转正"为核心船员提案。

贡献者守则与项目哲学

"这个项目是为已经筋疲力尽的人建造的。贡献应该让一切更简单，而不是更复杂。"

拿不准时问自己："这是否让一个勉强撑着生活的人的日子更容易了一点？"如果是，它就属于这里。行为准则只有一句：请友善——用你自己在状态最差时期希望得到的方式对待每位贡献者与用户。

🎯 写在最后

My-Brain-Is-Full-Crew 起源于一位博士研究者对抗记忆衰退的个人工具，如今它正等待更多双手。从修一个错别字到写一个全新适配器，每一条贡献都在让这个"AI 第二大脑船员"更强。翻开 CONTRIBUTING.md，今天就是你的贡献者第一天。

【免费下载链接】My-Brain-Is-Full-CrewBuilt by a PhD whose memory was failing, whose diet was a mess, and whose anxiety had its own agenda. Most second brain tools ignore the fact that your brain doesn't work in isolation: your body and your mental health are part of the system too. This crew handles all three: knowledge, nutrition, and mental wellness.项目地址: https://gitcode.com/gh_mirrors/my/My-Brain-Is-Full-Crew