Repomixへの貢献

Repomixにご興味をお持ちいただきありがとうございます！🚀 より良いものにするためのあなたの協力をお待ちしています。このガイドでは、プロジェクトへの貢献を始めるための手順を説明します。

貢献の方法

• リポジトリをスターする: リポジトリをスターして応援してください！
• イシューの作成: バグを見つけた？新機能のアイデアがある？イシューを作成して教えてください。
• プルリクエストの提出: 修正や改善点を見つけた？ぜひPRを送ってください！
• 言葉を広める: SNS、ブログ、または技術コミュニティでRepomixの経験を共有してください。
• Repomixを使用する: 実際の使用からのフィードバックが最も貴重です。あなた自身のプロジェクトにRepomixを組み込んでみてください！
• スポンサーする: スポンサーになることでRepomixの開発をサポートしてください。

開発環境のセットアップ

前提条件

• Node.js ≥ 20.0.0
• Git
• npm
• Docker（オプション、ウェブサイトの実行やコンテナ化された開発用）

ローカル開発

Repomixのローカル開発環境をセットアップするには：

# リポジトリのクローン
git clone https://github.com/yamadashy/repomix.git
cd repomix

# 依存関係のインストール
npm install

# CLIの実行
npm run repomix

Docker開発

Dockerを使用してRepomixを実行することもできます：

# イメージのビルド
docker build -t repomix .

# コンテナの実行
docker run -v ./:/app -it --rm repomix

プロジェクト構造

プロジェクトは次のディレクトリに整理されています：

src/
├── cli/          # CLI実装
├── config/       # 設定の処理
├── core/         # コア機能
│   ├── file/     # ファイル処理
│   ├── metrics/  # メトリクス計算
│   ├── output/   # 出力生成
│   ├── security/ # セキュリティチェック
├── mcp/          # MCPサーバー統合
└── shared/       # 共有ユーティリティ
tests/            # src/構造を反映したテスト
website/          # ドキュメントウェブサイト
├── client/       # フロントエンド（VitePress）
└── server/       # バックエンドAPI

開発コマンド

# CLIを実行
npm run repomix

# テストを実行
npm run test
npm run test-coverage

# コードのリント
npm run lint

テスト

テストにはVitestを使用しています。テストを実行するには：

# テストの実行
npm run test

# テストカバレッジ
npm run test-coverage

# リント
npm run lint-biome
npm run lint-ts
npm run lint-secretlint

コーディングスタイル

• Biomeを使用してリントとフォーマットを行う
• テスト可能性のために依存性注入を使用
• ファイルは250行以下に保つ
• 新機能には必ずテストを追加

リントとフォーマットにはBiomeを使用しています。コードがスタイルガイドに従っていることを確認するために以下を実行してください：

npm run lint

プルリクエストのガイドライン

プルリクエストを提出する前に、以下を確認してください：

1. コードが全てのテストをパスすること: npm run testを実行
2. コードがリント基準に適合していること: npm run lintを実行
3. 関連するドキュメントを更新していること
4. 既存のコードスタイルに従っていること

ウェブサイト開発

RepomixのウェブサイトはVitePressで構築されています。ローカルでウェブサイトを実行するには：

# 前提条件: システムにDockerがインストールされていること

# ウェブサイト開発サーバーの起動
npm run website

# ウェブサイトには http://localhost:5173/ でアクセス

ドキュメントを更新する場合は、最初に英語版のみを更新する必要があります。他の言語への翻訳はメンテナーが対応します。

リリースプロセス

メンテナーと貢献者向けのリリースプロセス：

1. バージョンの更新

npm version patch  # または minor/major

2. テストとビルドの実行

npm run test-coverage
npm run build

3. 公開

npm publish

新しいバージョンはメンテナーによって管理されます。リリースが必要だと思われる場合は、イシューを作成して議論してください。

サポートが必要な場合

• イシューを作成
• Discordに参加