開発への貢献

開発環境はuvで管理しています。 フロントエンドの依存関係はnpmでインストールします。

セットアップ

git clone https://github.com/nyoki-mtl/ShogiArena.git
cd ShogiArena
uv sync
npm ci

変更を確認する

主なコマンドは次のとおりです。 全コマンドはmake helpまたはMakefileで確認できます。

make format        # Pythonとフロントエンドのフォーマット
make lint          # Pythonのリント
make typecheck     # 型と依存関係の検査
make test          # Pythonのテスト
make frontend-test # フロントエンドのテスト
make ci            # 公開リポジトリのCIと同じ検査

make checkはフォーマットと静的検査を実行します。 テストもまとめて実行する場合はmake check-fullを使ってください。

ドキュメントを編集する

ドキュメントはdocs/book/src/のMarkdownからmdBookで生成します。 mdbookをインストールし、次のコマンドで表示を確認してください。

make docs-build    # HTMLを生成
make docs-serve    # プレビューを開く

実装の配置はプロジェクト構成にまとめています。