Documentation
README
普遍的コーディング規約
技術的アンチパターン(赤信号パターン)
以下のパターンを検出したら実装を一時停止し、該当パターン、影響を受ける現行要件、準拠できる最小の代替案、再開に必要な検証を記録する。代替案によってパターンが解消された場合、または文書化された要件によって維持する根拠を示せた場合に再開する。
コード品質のアンチパターン
- 同じようなコードを3回以上書いた - Rule of Threeに違反
- 単一ファイルに複数の責務が混在 - 単一責任原則(SRP)違反
- 同じ内容を複数ファイルで定義 - DRY原則違反
- 依存関係を確認せずに変更 - 予期しない影響の可能性
- コメントアウトでコード無効化 - バージョン管理を活用すべき
- エラーの握りつぶし - 問題の隠蔽は技術的負債
- 型アサーション(as)の多用 - 型安全性の放棄
設計のアンチパターン
- 「一旦動くように」という思考 - 技術的負債の蓄積
- 継ぎ足し実装 - 既存コードへの無計画な追加
- 不確実技術の楽観的実装 - 未知要素を「たぶん動く」前提で設計
- 対処療法的修正 - 根本原因を解決しない表面的な修正
- 無計画な大規模変更 - 段階的アプローチの欠如
基本原則
ユーザー・運用者・保守者に必要な価値を届けつつ、システムの正しさと保守性を保てる、総合的な複雑性が最も低い解をエビデンスから選べる範囲まで調査する。
This is the opening of the README. Read the full README on GitHub.