リグレッションバグレポートテンプレート
最後に動作していたバージョン、現在壊れているバージョン、変更履歴の参照フィールドを含むリグレッションIssue専用のバグレポートテンプレート。
Bug Reports
詳細な説明
リグレッションバグレポートテンプレート
リグレッションは、最近の変更によって導入されたバグで、以前動作していた機能を壊します。専用のリグレッションテンプレートは、メンテナが問題のあるコミットやリリースを素早く特定するのに役立ちます。
なぜ別のテンプレートが必要か?
標準的なバグレポートは予期しない動作の説明に焦点を当てます。リグレッションレポートには追加のコンテキストが必要です:
- 最後に動作したバージョン:ソフトウェアが正しく動作したバージョン
- 最初に壊れたバージョン:リグレッションが最初に気づかれた時期
- 変更履歴の参照:問題を導入した可能性のあるリリースやコミット
テンプレート構造
name: "Regression Report"
description: "以前動作していたが現在壊れているものを報告"
title: "[Regression]: "
labels: ["bug", "regression", "priority:high"]
body:
- type: input
id: last_working_version
attributes:
label: "最後に動作したバージョン"
description: "この機能が正しく動作した最新バージョン"
placeholder: "v2.3.0"
validations:
required: true
- type: input
id: broken_version
attributes:
label: "最初に壊れたバージョン"
description: "動作しなくなったバージョン"
placeholder: "v2.4.0"
validations:
required: true
トリアージのメリット
regressionとpriority:highラベルを自動適用することで、これらのIssueは即座に注目されます。バージョン範囲の情報により、開発者はgit bisectを実行してリグレッションを導入した正確なコミットを素早く見つけることができます。
ユースケース
定期的なリリースサイクルを持つソフトウェアプロジェクトで、より多くのユーザーに影響が及ぶ前にリグレッションを素早く特定・修正する必要があるもの、特にSaaSアプリケーションやセマンティックバージョニングを使用するライブラリ。