コントリビューション
こんにちは！このプロジェクトへの貢献に興味を持っていただきありがとうございます。このガイドは、あなたが始めるのに役立ちます。
前提条件
Windows のセットアップ
Visual Studio をダウンロードし、こちらの指示に従ってください: https://rust-lang.github.io/rustup/installation/windows-msvc.html#walkthrough-installing-visual-studio-2022
Visual Studio をインストールする際、Windows SDK と C++ ビルドツールを必ずインストールしてください。
PowerShell を開く
scoopをインストールpowershellSet-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser Invoke-RestMethod -Uri https://get.scoop.sh | Invoke-Expressionscoopを使ってgit, Node.js,rustup,msvcをインストールpowershellscoop install git nodejs rustup # Rust の依存関係用 # crates または apps/tamagotchi の開発を行わない場合は不要です scoop install main/rust-msvc # Rust & Windows 固有 rustup toolchain install stable-x86_64-pc-windows-msvc rustup default stable-x86_64-pc-windows-msvccorepackを使ってpnpmをインストールpowershellcorepack enable corepack prepare pnpm@latest --activate
macOS のセットアップ
Terminal (または iTerm2, Ghostty, Kitty など) を開く
brewを使ってgit,nodeをインストールshellbrew install git nodecorepackを使ってpnpmをインストールshellcorepack enable corepack prepare pnpm@latest --activate
Linux のセットアップ
Terminal を開く
nodesource/distributions: NodeSource Node.js Binary Distributions に従って
nodeをインストールGit に従って
gitをインストールcorepackを使ってpnpmをインストールshellcorepack enable corepack prepare pnpm@latest --activateデスクトップ版の開発を手助けしたい場合は、以下の依存関係が必要です：
sudo apt install \ libssl-dev \ libglib2.0-dev \ libgtk-3-dev \ libjavascriptcoregtk-4.1-dev \ libwebkit2gtk-4.1-dev
以前にこのプロジェクトに貢献したことがある場合
WARNING
このリポジトリをクローンしていない場合は、このセクションをスキップしてください。
ローカルリポジトリがアップストリームリポジトリと最新の状態であることを確認してください：
git fetch -all
git checkout main
git pull upstream main --rebase作業中のブランチがある場合、ブランチをアップストリームリポジトリと最新の状態にするには：
git checkout <your-branch-name>
git rebase mainこのプロジェクトをフォークする
moeru-ai/airi ページの右上にある Fork ボタンをクリックしてください。
クローン
git clone https://github.com/<your-github-username>/airi.git
cd airi作業用ブランチを作成する
git checkout -b <your-branch-name>依存関係のインストール
corepack enable
pnpm install
# Rust の依存関係用
# crates または apps/tamagotchi の開発を行わない場合は不要です
cargo fetchTIP
スクリプトを簡単にするために @antfu/ni のインストールをお勧めします。
corepack enable
npm i -g @antfu/niインストールしたら、以下のように使用できます
pnpm install,npm install,yarn installの代わりにniを使用。pnpm run,npm run,yarn runの代わりにnrを使用。
パッケージマネージャーを気にする必要はありません。ni が適切なものを選択してくれます。
開発したいアプリケーションを選択する
Stage Tamagotchi (デスクトップ版)
pnpm dev:tamagotchiStage Web (Web 版 airi.moeru.ai 用)
pnpm devドキュメントサイト
pnpm dev:docsTelegram bot 統合
Postgres データベースが必要です。
cd services/telegram-bot
docker compose up -d.env の設定
cp .env .env.local.env.local 内の認証情報を編集します。
データベースのマイグレーション
pnpm -F @proj-airi/telegram-bot db:generate
pnpm -F @proj-airi/telegram-bot db:pushボットの実行
pnpm -F @proj-airi/telegram-bot startDiscord bot 統合
cd services/discord-bot.env の設定
cp .env .env.local.env.local 内の認証情報を編集します。
ボットの実行
pnpm -F @proj-airi/discord-bot startMinecraft エージェント
cd services/minecraftMinecraft クライアントを起動し、希望のポートでワールドを公開し、そのポート番号を .env.local に記入します。
.env の設定
cp .env .env.local.env.local 内の認証情報を編集します。
ボットの実行
pnpm -F @proj-airi/minecraft-bot startコミット
コミットの前に
WARNING
リント (静的チェッカー) と TypeScript コンパイラが満たされていることを確認してください：
pnpm lint && pnpm typecheckコミット
git add .
git commit -m "<your-commit-message>"フォークリポジトリへのプッシュ
git push origin <your-branch-name> -uフォークリポジトリでブランチを閲覧できるはずです。
TIP
このプロジェクトへの貢献が初めての場合は、アップストリームリポジトリも追加する必要があります：
git remote add upstream https://github.com/moeru-ai/airi.gitプルリクエストの作成
moeru-ai/airi ページに移動し、Pull requests タブをクリックし、New pull request ボタンをクリックします。Compare across forks リンクをクリックし、あなたのフォークリポジトリを選択します。
変更を確認し、Create pull request ボタンをクリックします。
やったー！できました！
おめでとうございます！このプロジェクトへの最初の貢献を行いました。メンテナーがプルリクエストをレビューするのを待つことができます。