MINARA
贡献指南

参与 Minara 贡献

选择正确的扩展点,搭建开发环境,并提交便于审查的 Pull Request

Minara 的成长来自一项项聚焦的贡献:一段更清楚的文字、一个更安全的工具、一项更扎实的研究技能,或一套更好的多 Agent 协作流程。请从能够解决真实问题的最小改动开始,并留下他人可以复核的证据。

仓库级 CONTRIBUTING 指南介绍 Issue 分流、Pull Request 要求、许可证和社区入口。本节聚焦 Minara 特有的扩展方式。

选择改动位置

你想改变什么从这里开始
文档或翻译同步修改四种语言,并运行下方检查
使用现有工具补充领域知识或可复用流程新增技能
增加确定性处理、认证 API 或新的执行能力新增工具
扩展机构模式的分析框架或深度研究流程新增分析 Playbook
增加可复用、可检验的投资规则新增方法论
修改 Runtime、Web UI、桌面端或共享包先阅读系统设计和最近的包级指南

现有工具已经具备所需能力时,优先新增技能。需要认证、确定性数据处理、二进制或流式处理,或必须建立执行边界时,再新增工具。应用特有逻辑留在对应应用内,跨应用契约放入相应共享包。

搭建开发环境

你需要 Node.js 24 或更高版本,以及通过 Corepack 管理的 pnpm 9.15.0。

git clone https://github.com/Minara-AI/minara-agent.git
cd minara-agent
corepack enable
pnpm install
pnpm build:packages

启动正在修改的界面:

pnpm dev:agent
pnpm dev:web-ui
pnpm dev:docs

开始编辑前,请阅读根目录 CLAUDE.md、最近的应用或包级 CLAUDE.md,以及所有匹配的 .claude/rules/*.md。这些文件是人类与自动化开发工具共同遵守的工程契约。

验证改动

先运行最聚焦的测试,再执行对应区域的完整检查。

# Agent
pnpm --filter @minara/agent typecheck
pnpm --filter @minara/agent test:unit

# Web UI
pnpm --filter @minara/web-ui typecheck
pnpm --filter @minara/web-ui build

# 文档
pnpm --filter @minara/docs check:i18n
pnpm --filter @minara/docs lint:translations
pnpm --filter @minara/docs build

公共文档同步发布英文、中文、日文和韩文。修改手写 MDX 时,需要同时更新 .mdx.cn.mdx.ja.mdx.ko.mdx。内部链接保持语言无关,例如 /docs/contributing/conventions

提交便于审查的 Pull Request

一个 Pull Request 只解决一个逻辑问题。请说明问题、改动原因、用户影响,以及用于验证的命令或截图。涉及公共 API、架构或多个子系统的工作,应先创建 Issue 讨论范围。

禁止提交密钥、账户数据、用户交易数据或许可证不兼容的第三方材料。可被利用的安全漏洞请通过 GitHub 私密漏洞报告提交。

接下来请阅读项目级贡献约定

本页目录