このプロジェクトでは docs/01_GUIDE/ 以下に定義されたルールを必ず遵守すること。
各ファイルの詳細はリンク先を参照する。
テキストドキュメントの書式全般を定義する。句読点は「,」「.」を使用し「、」「。」は使わない。 見出し階層(大見出し・中見出し・■・・・・-)や空行ルールに従うこと。
ドキュメントファイルは [カテゴリ]_[連番]_[名称].txt の形式で命名する。
カテゴリ(GUIDE / PLAN / ENV / SPEC / TECH / TEST / ADR)の定義もここに記載されている。
ブランチ命名(feature/・fix/・refactor/ 等),コミットメッセージのタグ([add]・[update]・[fix]・[remove]・[clean]),PR フロー(必ず PR 経由でマージ,直プッシュ禁止)を定義する。
Python コードの書き方を定義する。PEP 8 準拠,snake_case / PascalCase / UPPER_SNAKE_CASE の使い分け,
型ヒント必須,from ... import * 禁止,マジックナンバー禁止など。
コメント・docstring の書き方を定義する。モジュール・クラス・公開関数には docstring 必須。 コメントは日本語,句読点は「,」を使用,文末の「.」は付けない。Google スタイルの docstring を使用する。