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 私密漏洞報告提交。

接下來請閱讀項目級貢獻約定

本頁目錄