Skip to content

Latest commit

 

History

History
29 lines (22 loc) · 1.53 KB

File metadata and controls

29 lines (22 loc) · 1.53 KB
  • 型ヒントを必ず書いてください
  • コードには日本語のコメントを出来るだけ入れてください
  • 仕様を書くときはmarkdown形式で出力し、言語は日本語で。仕様や設計を書くときは必ずコード例は出さずに処理内容を日本語で記載してください

設定管理ルール

新規設定の追加方法

新しい設定項目を追加する際は、必ず以下の手順に従ってください:

  1. config.yamlへの追加(必須)

    • 全ての設定項目はconfig.yamlに定義する
    • 適切なセクション(github、gitlab、database等)に配置
    • デフォルト値を明記
  2. 環境変数での上書き対応(必要に応じて)

    • 環境変数での設定が必要な場合は、main.pyload_config()に処理を追加
    • 新規の_override_*_config()関数を作成するか、既存関数に追加
    • 環境変数が設定されている場合はconfig辞書を上書き
  3. 例外となる環境変数

    • CONFIG_FILE: 起動時にconfig.yamlのパスを指定するため、直接参照を許可
    • DEBUG: setup_logger()で直接参照が必要
    • LOGS: setup_logger()で直接参照が必要
    • 上記以外の環境変数は、必ずmain.pyload_config()経由でconfigに反映すること
  4. 禁止事項

    • コード内でos.environ.get()を直接使用することを禁止(上記3つの例外を除く)
    • 設定値は必ずconfig辞書から取得すること