スナップショットテストガイドの作成

[Hiroshiba]

内容

スナップショットテストの運用ガイドを作成し、「いつ」「どのように」スナップショットを更新すべきかを書いておきたいです。

ドキュメントは docs/スナップショットテスト.md に配置する想定です。
テストが落ちた際にはガイドを参照して、誤差なのか仕様変更なのかの判断や、更新の仕方を確認できるようにしたいです。

他にも

• PRやレビュー時の運用ベストプラクティス
• 画像スナップショットのように微妙な変化が出やすいケースの注意点
• スナップショットテストを使わない方が良いケースの例示

などをまとめると良いかも。

Pros 良くなる点

• スナップショットテストの更新ルールが明確になり、開発者間での認識齟齬が減る
• 適切なテスト管理を行うことで、不要な差分ファイルの肥大化を抑制できる

Cons 悪くなる点

• ガイド作成やルール整備に時間がかかる

実現方法

• docs/スナップショットテスト.md にガイドを作成
  • 「スナップショットテストとは何か」「スナップショット更新の判断基準」などを記載

↓オプション

• テストが失敗した場合のエラーメッセージに「ガイドを参照する」旨の案内を追加
• 必要に応じてテストコード側に「自動更新可否」などの設定を設けるなど、運用と実装の両面で工夫する

その他