- 型ヒントを必ず書いてください
- コードには日本語のコメントを出来るだけ入れてください
- 仕様を書くときはmarkdown形式で出力し、言語は日本語で。仕様や設計を書くときは必ずコード例は出さずに処理内容を日本語で記載してください
新しい設定項目を追加する際は、必ず以下の手順に従ってください:
-
config.yamlへの追加(必須)
- 全ての設定項目は
config.yamlに定義する - 適切なセクション(github、gitlab、database等)に配置
- デフォルト値を明記
- 全ての設定項目は
-
環境変数での上書き対応(必要に応じて)
- 環境変数での設定が必要な場合は、
main.pyのload_config()に処理を追加 - 新規の
_override_*_config()関数を作成するか、既存関数に追加 - 環境変数が設定されている場合は
config辞書を上書き
- 環境変数での設定が必要な場合は、
-
例外となる環境変数
CONFIG_FILE: 起動時にconfig.yamlのパスを指定するため、直接参照を許可DEBUG:setup_logger()で直接参照が必要LOGS:setup_logger()で直接参照が必要- 上記以外の環境変数は、必ず
main.pyのload_config()経由でconfigに反映すること
-
禁止事項
- コード内で
os.environ.get()を直接使用することを禁止(上記3つの例外を除く) - 設定値は必ず
config辞書から取得すること
- コード内で