Skip to content

品質標準プロトコル (Quality Standard)

品質標準 (skills/references/quality.md) は、tddreviewshiparchiveonboard で強制適用される品質基準を定義しています。

3次元品質検証

実装およびリファクタリングサイクルごとに、以下の4つの観点から検証を行います。

1. メカニカルチェック (Mechanical Checks)

  • Lint ルールが警告なしで完全にパスすること。
  • コードフォーマットがプロジェクト設定に準拠していること。
  • any による回避や型エラー抑制なしで型チェック(Typecheck)がパスすること。

2. 規約の遵守 (Convention Adherence)

  • 仕様書(convention:)で宣言されたプロジェクト固有の慣習およびスタックのベストプラクティスを遵守していること。
  • イディオマティックな構造、エラー処理パターン、命名規約を評価します。

3. 設計評価 (Design Assessment)

  • 高凝集・低結合: 関数やクラスが高凝集であり、モジュール間の結合が最小限であること。
  • 適切な抽象化レベル: 早すぎたり不必要な抽象化を回避し、契約を満たす最小限の実装にとどめること。

4. ドキュメントカバレッジ (Documentation Coverage)

  • すべての公開関数、API エンドポイント、エクスポートインターフェース、環境変数、障害モードが正確に記録されていること。
  • README.md のコマンドや例が実行可能かつ最新であること。
  • ドキュメント更新を伴わないコード変更は Code Review で不合格となります。

Released under the MIT License.