MINARA
コントリビューティング

Minara への貢献

適切な拡張ポイントを選び、開発環境を整え、レビューしやすい Pull Request を作る

Minara は、焦点の定まった一つひとつの貢献によって成長します。説明を一段わかりやすくすること、安全なツールを加えること、調査スキルやマルチ Agent の流れを磨くことも大切な貢献です。実際の問題を解く最小の変更から始め、他の人が確認できる証拠を残してください。

リポジトリ全体の CONTRIBUTING ガイドでは、Issue の使い分け、Pull Request の要件、ライセンス、コミュニティ窓口を説明しています。このセクションでは Minara 固有の拡張ポイントを扱います。

変更先を選ぶ

変更したいもの最初に読むページ
ドキュメントまたは翻訳四言語を同時に更新し、下記のチェックを実行
既存ツールを使う専門知識や再利用可能な手順スキルの追加
決定的な処理、認証付き API、新しい実行機能ツールの追加
Institution Mode の分析枠組みや Deep Research の手順分析 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 Private Vulnerability Reporting から報告してください。

続いて、プロジェクト共通の規約を確認してください。

目次