dev_ja.md

開発ガイド

English | 中文 | 日本語 | Español | 한국어

1. コードスタイル

コードスタイルには PEP8 を採用しています。

リンティングとフォーマットには以下のツールを使用しています：

• flake8：リンター
• yapf：フォーマッター
• isort：import の並び替え

yapf と isort のスタイル設定は setup.cfg にあります。 pre-commit hook を使用しており、コミットのたびに flake8、yapf、seed-isort-config、isort、trailing whitespaces のチェックとフォーマットを自動的に行い、 end-of-files を修正し、requirements.txt を自動的に整理します。 pre-commit hook の設定は .pre-commit-config に保存されています。 リポジトリをクローンしたら、pre-commit hook をインストールして初期化する必要があります。

pip install -r requirements-test.txt

リポジトリのルートディレクトリで：

pre-commit install

これ以降、コミットのたびにコードのリンティングとフォーマットが自動的に適用されます。

すべてのファイルに対して pre-commit チェックを実行したい場合は、次のコマンドを実行してください：

pre-commit run --all-files