コントリビューション¶
前提条件¶
- Python 3.11+
- uv パッケージマネージャ
- Git
ローカル開発¶
# リポジトリをクローン
git clone https://github.com/Zts0hg/codexspec.git
cd codexspec
# 開発依存関係をインストール
uv sync --dev
# ローカルで実行
uv run codexspec --help
# テストを実行
uv run pytest
# コードをリント
uv run ruff check src/
ドキュメント¶
# ドキュメントの依存関係をインストール
uv sync --extra docs
# ドキュメントをローカルでプレビュー
uv run mkdocs serve
# ドキュメントをビルド
uv run mkdocs build
ビルド¶
プルリクエストのプロセス¶
- リポジトリをフォーク
- 機能ブランチを作成
- 変更を加える
- テストとリントを実行
- プルリクエストを提出
コードスタイル¶
- 行の長さ: 最大 120 文字
- PEP 8 に従う
- 公開関数には型ヒントを使用