From 3338a518fe535cb1ee83fdbcbcc3420e63e21f78 Mon Sep 17 00:00:00 2001 From: Jeffery Date: Thu, 14 May 2026 02:02:58 +0000 Subject: [PATCH] docs: streamline triage skill triggers --- .claude/skills/triage-findings/SKILL.md | 40 ++++++++----------------- .gemini/skills/triage-findings/SKILL.md | 40 ++++++++----------------- .github/copilot-instructions.md | 2 ++ .github/skills/triage-findings/SKILL.md | 40 ++++++++----------------- README.md | 35 ++++++++-------------- 5 files changed, 50 insertions(+), 107 deletions(-) diff --git a/.claude/skills/triage-findings/SKILL.md b/.claude/skills/triage-findings/SKILL.md index 423d595..ac823cf 100644 --- a/.claude/skills/triage-findings/SKILL.md +++ b/.claude/skills/triage-findings/SKILL.md @@ -1,44 +1,28 @@ --- name: triage-findings -description: Merge code-review findings, sort and renumber them by severity, resolve real issues, and move false positives into exclusions. +description: Triage findings, fix real issues, and exclude false positives. --- # Triage Findings -## When To Use +## Use -Use this skill when you receive multiple review findings, screenshots, comments, or issue lists that need to become one final triaged list. -It is also used when some findings are false positives and should be moved into the exclusions list. +直接輸入：`triage-findings 問題原始檔(文字或截圖)` ## Workflow -1. Collect all findings into one list. -2. Merge duplicates into a single finding when they describe the same issue. -3. Sort the final list by severity: +1. Merge all findings. +2. Sort by severity: - critical - warning - info -4. Renumber the sorted list from 1 upward. -5. Rewrite each finding concisely so the final list reads cleanly and consistently. -6. If a finding is a false positive, do not keep it in the final list. -7. Add false positives to the exclusions list using the existing schema in the repo or task context. - -## Resolution Flow - -After the list is merged and ordered, resolve the remaining findings one by one. - -1. Start from the highest severity item. -2. Identify the root cause in the relevant file or context. -3. Apply the smallest safe change that fixes the issue. -4. Add or update tests when behavior changes. -5. Re-check the issue after the change. -6. If the item is confirmed false positive, move it to exclusions instead of changing code. -7. Continue until the list is either fixed or explicitly excluded. +3. Renumber from 1. +4. Fix real issues. +5. Put false positives into `.gitea/ai-review/exclusions.json`. +6. Add tests when behavior changes. ## Output Rules -- Keep the final findings list in severity order, then by any stable secondary order needed to make it readable. -- Keep numbering contiguous after filtering and merging. -- Preserve useful details like file path, location, and suggested fix. -- Keep exclusions entries minimal and consistent with the project schema. -- If the source already provides a severity or title, keep it unless it conflicts with the final ordering. +- Keep the final list short. +- Keep numbering contiguous. +- Preserve file path, location, and fix. diff --git a/.gemini/skills/triage-findings/SKILL.md b/.gemini/skills/triage-findings/SKILL.md index 423d595..ac823cf 100644 --- a/.gemini/skills/triage-findings/SKILL.md +++ b/.gemini/skills/triage-findings/SKILL.md @@ -1,44 +1,28 @@ --- name: triage-findings -description: Merge code-review findings, sort and renumber them by severity, resolve real issues, and move false positives into exclusions. +description: Triage findings, fix real issues, and exclude false positives. --- # Triage Findings -## When To Use +## Use -Use this skill when you receive multiple review findings, screenshots, comments, or issue lists that need to become one final triaged list. -It is also used when some findings are false positives and should be moved into the exclusions list. +直接輸入：`triage-findings 問題原始檔(文字或截圖)` ## Workflow -1. Collect all findings into one list. -2. Merge duplicates into a single finding when they describe the same issue. -3. Sort the final list by severity: +1. Merge all findings. +2. Sort by severity: - critical - warning - info -4. Renumber the sorted list from 1 upward. -5. Rewrite each finding concisely so the final list reads cleanly and consistently. -6. If a finding is a false positive, do not keep it in the final list. -7. Add false positives to the exclusions list using the existing schema in the repo or task context. - -## Resolution Flow - -After the list is merged and ordered, resolve the remaining findings one by one. - -1. Start from the highest severity item. -2. Identify the root cause in the relevant file or context. -3. Apply the smallest safe change that fixes the issue. -4. Add or update tests when behavior changes. -5. Re-check the issue after the change. -6. If the item is confirmed false positive, move it to exclusions instead of changing code. -7. Continue until the list is either fixed or explicitly excluded. +3. Renumber from 1. +4. Fix real issues. +5. Put false positives into `.gitea/ai-review/exclusions.json`. +6. Add tests when behavior changes. ## Output Rules -- Keep the final findings list in severity order, then by any stable secondary order needed to make it readable. -- Keep numbering contiguous after filtering and merging. -- Preserve useful details like file path, location, and suggested fix. -- Keep exclusions entries minimal and consistent with the project schema. -- If the source already provides a severity or title, keep it unless it conflicts with the final ordering. +- Keep the final list short. +- Keep numbering contiguous. +- Preserve file path, location, and fix. diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.md index f6468cd..92710d5 100644 --- a/.github/copilot-instructions.md +++ b/.github/copilot-instructions.md @@ -12,3 +12,5 @@ When the task is to triage review findings, follow this workflow: 8. Re-check the issue after each fix. Use the repo-local `triage-findings` skill for the same workflow when running in Codex. + +Trigger it with `/triage-findings`. diff --git a/.github/skills/triage-findings/SKILL.md b/.github/skills/triage-findings/SKILL.md index 423d595..01e14d5 100644 --- a/.github/skills/triage-findings/SKILL.md +++ b/.github/skills/triage-findings/SKILL.md @@ -1,44 +1,28 @@ --- name: triage-findings -description: Merge code-review findings, sort and renumber them by severity, resolve real issues, and move false positives into exclusions. +description: Triage findings, fix real issues, and exclude false positives. --- # Triage Findings -## When To Use +## Use -Use this skill when you receive multiple review findings, screenshots, comments, or issue lists that need to become one final triaged list. -It is also used when some findings are false positives and should be moved into the exclusions list. +`triage-findings 問題原始檔(文字或截圖)` ## Workflow -1. Collect all findings into one list. -2. Merge duplicates into a single finding when they describe the same issue. -3. Sort the final list by severity: +1. Merge all findings. +2. Sort by severity: - critical - warning - info -4. Renumber the sorted list from 1 upward. -5. Rewrite each finding concisely so the final list reads cleanly and consistently. -6. If a finding is a false positive, do not keep it in the final list. -7. Add false positives to the exclusions list using the existing schema in the repo or task context. - -## Resolution Flow - -After the list is merged and ordered, resolve the remaining findings one by one. - -1. Start from the highest severity item. -2. Identify the root cause in the relevant file or context. -3. Apply the smallest safe change that fixes the issue. -4. Add or update tests when behavior changes. -5. Re-check the issue after the change. -6. If the item is confirmed false positive, move it to exclusions instead of changing code. -7. Continue until the list is either fixed or explicitly excluded. +3. Renumber from 1. +4. Fix real issues. +5. Put false positives into `.gitea/ai-review/exclusions.json`. +6. Add tests when behavior changes. ## Output Rules -- Keep the final findings list in severity order, then by any stable secondary order needed to make it readable. -- Keep numbering contiguous after filtering and merging. -- Preserve useful details like file path, location, and suggested fix. -- Keep exclusions entries minimal and consistent with the project schema. -- If the source already provides a severity or title, keep it unless it conflicts with the final ordering. +- Keep the final list short. +- Keep numbering contiguous. +- Preserve file path, location, and fix. diff --git a/README.md b/README.md index 1c90171..1932fdb 100644 --- a/README.md +++ b/README.md @@ -202,36 +202,25 @@ jobs: ## Skill：Triage Findings -這份 skill 用來處理收到的 review 問題清單，流程是先合併成單一列表，再依嚴重度排序、重新編號，最後逐項修正或排除誤判。 +這份 skill 用來處理 review 問題清單。 ### 規則 -1. 先把所有問題合併成一個列表。 +1. 合併問題。 2. 依嚴重度排序：`critical` -> `warning` -> `info`。 -3. 重新從 `1` 開始編號。 -4. 若問題屬於真實缺陷，就直接修正。 -5. 若問題是誤判，就加入 `.gitea/ai-review/exclusions.json`。 -6. 修正時以最小安全變更為原則，必要時補測試。 -7. 修正後要重新確認問題是否仍存在。 +3. 重新編號。 +4. 真問題就修。 +5. 誤判就加到 `.gitea/ai-review/exclusions.json`。 +6. 有變更就補測試。 ### 使用方式 -在 Codex 裡直接用 `$triage-findings` 觸發，或直接描述你的需求，例如： - -1. 把收到的 review 問題貼給它。 -2. 要求它先合併、排序、重新編號。 -3. 要求它逐項修正真實問題。 -4. 如果某項是誤判，要求它加入 `.gitea/ai-review/exclusions.json`。 - -例如： - -- `請幫我整理這批 review 問題，合併後依嚴重度排序並重新編號` -- `這些問題裡哪些是誤判？請幫我加入 exclusions` -- `請依照合併後的列表逐項修正問題` +Codex：`$triage-findings 問題原始檔(文字或截圖)` +Copilot：`/triage-findings 問題原始檔(文字或截圖)` +Claude：直接輸入 `triage-findings 問題原始檔(文字或截圖)` +Gemini：直接輸入 `triage-findings 問題原始檔(文字或截圖)` +Amazon Q：直接輸入 `triage-findings 問題原始檔(文字或截圖)` ### 適用情境 -- 多張截圖或多段 review 結果需要整併 -- 問題清單需要重新排序與編號 -- 需要把誤判移出主要問題列表 -- 需要依清單逐項修正程式碼並補測試 +`triage-findings 問題原始檔(文字或截圖)` 用在 review 問題整併、排序、修正、排除誤判。