チケット技術事後分析(1フィールド+参照方式)
ユーザーはすべてを1つのフィールドにまとめ、他の分析フィールドからそのフィールドを参照させます。これにより同じことを二度記述する必要がありません。このワークフローを再現してください。
設定
~/.config/skills/analyse-causes/config.md を最初に読んでください。このファイルには、トラッカーとそのツール、プロジェクトとチケットのキーパターン、フィールドフォーマット、記述言語と見出し、記述フィールド、参照先のテキストを含む参照フィールド、MRリンクフィールドが設定されています。設定ファイルがない場合は、config.example.md(このファイルの隣)を ~/.config/skills/analyse-causes/config.md にコピーして内容を記入するようユーザーに伝え、処理を停止してください。
ターゲット: 引数として渡されたチケット。それ以外の場合は、セッション内で進行中の修正(diff/branch/MR)を対象とします。
生成内容
1つの完全な記述文書を、設定された言語でマークダウン形式で作成します。設定された見出しの下に2つのセクションを含めます:
- 根本原因 - 技術的なWHY。初期状況(症状/チケットの説明)を再記述しないでください。真の起源に遡ってください: 設計上の選択、
constant/file:line、誤った前提。目に見える症状は絶対に含めないでください。 - 修正 - 何が変更され、なぜそれが根本原因を取り除くのか。事実に基づいて: 選択されたメカニズム、触れたファイル/定数、結果としての動作。ここにMRリンクは含めないでください: MRリンクは設定されたMRリンクフィールドに記述します。
ルール: 簡潔、短い箇条書き、正確な用語(constants、functions、file:line)、実際のコードと照合すること。emダッシュ(U+2014)は使用しないでください。代わりにハイフン、カンマ、または言い換えてください。
手順
- チケットを特定する: 引数が設定されたパターンに一致するキーの場合はそのチケット、そうでない場合は進行中の修正(セッションのdiff/branch/MR)を対象とする。
- 必要に応じて設定されたツールでチケットを読むが、その説明をコピーしない。
- コード内で根本原因を追跡し、修正の変更点(git diff/MR)をリストアップする。
- 完全な記述文書を作成する。
- それを表示し、設定されたフォーマットでフィールドに書き込む:
- 記述フィールド <- 完全な記述文書
- 各参照フィールド <- 設定された参照テキストを含む1段落のドキュメント チケットがターゲットでない場合(キーのないセッション内の修正のみ)は、記述文書のみを表示し、フィールドへの書き込みを提案する。