コントリビューション

Komugi への機能追加やバグ修正のコントリビューションを歓迎します。

開発の原則

1. 高耐障害性: パケットのパース不備や予期せぬ例外でプロセス全体を落とさないよう、Goroutine やハンドラには適切なリカバリを設けてください。
2. Pure Go / Cgo-free: クロスコンパイルの容易性とコンテナでの運用のしやすさを保つため、Cgo に依存するライブラリの追加は極力避けてください。
3. テストの徹底: 変更を加えた際は go test -race ./... が通ることを確認してください。

---

新しいゲーム内コマンドを追加する手順

1. コマンド定義の追加 (internal/relay/commands.go)

   KomugiCommands() 関数内に新しいコマンドのメタデータ（名前、説明、引数定義）を追加します:

   {
       Name:        "mycommand",
       Description: "新しいコマンドの説明文",
       AliasesOffset: 0xFFFFFFFF,
       Overloads:   []protocol.CommandOverload{{}},
   }

2. ハンドラの追加 (handleKomugiCommand)

   session.handleKomugiCommand 内で該当コマンドの実行処理（トースト送信、パケット送出、DB更新など）を記述します:

   if matchCmd(cmdLower, "/mycommand") {
       // コマンド処理ロジック
       return
   }

3. ドキュメントの自動更新

   ドキュメントリポジトリ側で生成スクリプトを実行するだけで、追加したコマンドが ゲーム内コマンド一覧 に自動的に反映されます:

   cd ../komugi-docs
   pnpm run generate

---

新しい環境変数を追加する手順

1. 設定構造体の更新 (internal/config/config.go)

   Config 構造体にフィールドを追加し、loadEnv() 関数で環境変数読み込みとバリデーションを実装します。

2. .env.example への追記

   リポジトリ直下の .env.example に、設定例と日本語の説明コメントを追記します。

3. ドキュメントの自動更新

   ドキュメント生成スクリプトを実行すると、.env.example の内容から 環境変数リファレンス が自動的に再生成されます。