docs(審查步驟編號): 依新順序重編步驟編號與說明
This commit is contained in:
+13
-13
@@ -2,10 +2,10 @@
|
||||
|
||||
// 固定留言模板:本 action 發到 PR 的留言一律由此產生(繁體中文、UTF-8、表格優先)。
|
||||
|
||||
// 隱藏標記:辨識哪些留言是本 action 發的(步驟 8 標註過時時使用)。
|
||||
// 隱藏標記:辨識哪些留言是本 action 發的(步驟 2 標註過時時使用)。
|
||||
const MARK = '<!-- ai-code-review -->';
|
||||
|
||||
// 舊留言標註前綴(步驟 8 的降級做法:無 resolve API 時編輯加註)。
|
||||
// 舊留言標註前綴(步驟 2 的降級做法:無 resolve API 時編輯加註)。
|
||||
const OUTDATED_PREFIX = '> 〔已過時〕本留言屬於較舊的審查回合。\n\n';
|
||||
|
||||
// 嚴重等級對應的 emoji 與排序權重。
|
||||
@@ -33,7 +33,7 @@ const FOCUS_LABEL = {
|
||||
* @param {*} text - 任意待處理內容;非字串會先以 `String()` 轉型,null/undefined 視為空字串。
|
||||
* @returns {string} 已逸出、單行化的儲存格內容;若結果為空則回傳 `'—'`。
|
||||
* @remarks
|
||||
* 使用情境:審查流程中所有表格型留言的共用防呆——例如步驟 3 的
|
||||
* 使用情境:審查流程中所有表格型留言的共用防呆——例如步驟 4 的
|
||||
* `diffComment()` 產生變更摘要表格時,檔名與用途欄位都經本函式處理,
|
||||
* 避免檔名或 AI 產生的描述含 `|` 或換行而撐破 Markdown 表格。
|
||||
* 本函式未匯出,僅供模組內部使用。
|
||||
@@ -55,7 +55,7 @@ function cell(text) {
|
||||
* @param {string} focus - 審查面向代碼(例如 `'logic'`、`'security'`);可為 undefined。
|
||||
* @returns {string} 顯示字串:命中時如 `'邏輯(logic)'`;未命中時原樣回傳 `focus`;falsy 時回傳 `'—'`。
|
||||
* @remarks
|
||||
* 使用情境:審查流程步驟 4/6 的角色登場留言——`rolesComment()`
|
||||
* 使用情境:審查流程步驟 5/6 的角色登場留言——`rolesComment()`
|
||||
* 產生「角色|面向|個性」表格時,以本函式把每位審查員
|
||||
* (攻擊方/防守方)的 focus 代碼轉成中英並列的面向欄位內容。
|
||||
* 本函式未匯出,僅供模組內部使用。
|
||||
@@ -66,7 +66,7 @@ function focusLabel(focus) {
|
||||
}
|
||||
|
||||
/**
|
||||
* 產生審查流程步驟 2 的「審查工具」PR 留言內容。
|
||||
* 產生審查流程步驟 3 的「審查工具」PR 留言內容。
|
||||
*
|
||||
* 留言以隱藏標記 `MARK` 開頭,包含工具資訊表格(工具/版本/模型/
|
||||
* 審查 commit/Run Job 連結)與一張 mermaid 流程圖,說明整條審查管線
|
||||
@@ -81,9 +81,9 @@ function focusLabel(focus) {
|
||||
* @param {string} params.runLink - CI run 的網址,直接內插為 Markdown 連結目標。
|
||||
* @returns {string} 完整留言 Markdown 字串(含 MARK 隱藏標記,結尾帶換行)。
|
||||
* @remarks
|
||||
* 使用情境:審查流程步驟 2——每回合審查開始時,先把工具身分與
|
||||
* 使用情境:審查流程步驟 3——每回合審查開始時,先把工具身分與
|
||||
* 管線流程圖留言到 PR,讓開發者知道這回合由哪個版本/模型執行;
|
||||
* 留言開頭的 MARK 讓步驟 8 能辨識並將舊回合留言標註為過時。
|
||||
* 留言開頭的 MARK 讓步驟 2 能辨識並將舊回合留言標註為過時。
|
||||
*/
|
||||
function toolComment({ toolName, version, model, sha, runNumber, runLink }) {
|
||||
return `${MARK}
|
||||
@@ -108,7 +108,7 @@ flowchart LR
|
||||
}
|
||||
|
||||
/**
|
||||
* 產生審查流程步驟 3 的「變更摘要(送審 git diff)」PR 留言內容。
|
||||
* 產生審查流程步驟 4 的「變更摘要(送審 git diff)」PR 留言內容。
|
||||
*
|
||||
* 以四欄表格(檔案/用途/git diff 長度/最後更新時間)列出本回合
|
||||
* 送審的每個檔案;diff 過長被截斷送審的檔案會加註「(過長截斷送審)」,
|
||||
@@ -125,7 +125,7 @@ flowchart LR
|
||||
* @param {number} ignoredCount - 依 `.reviewignore` 排除的檔案數;大於 0 才顯示排除註記。
|
||||
* @returns {string} 完整留言 Markdown 字串(含 MARK 隱藏標記)。
|
||||
* @remarks
|
||||
* 使用情境:審查流程步驟 3——整理完 git diff 後,把「哪些檔案、多長、
|
||||
* 使用情境:審查流程步驟 4——整理完 git diff 後,把「哪些檔案、多長、
|
||||
* 是否截斷、哪些被 .reviewignore 排除」留言到 PR,讓開發者確認送審範圍
|
||||
* 與 AI 實際看到的內容一致。
|
||||
*/
|
||||
@@ -150,10 +150,10 @@ function diffComment(rows, ignoredCount) {
|
||||
}
|
||||
|
||||
/**
|
||||
* 產生審查流程步驟 4/6 共用的「角色登場」PR 留言內容。
|
||||
* 產生審查流程步驟 5/6 共用的「角色登場」PR 留言內容。
|
||||
*
|
||||
* 以三欄表格(角色/面向/個性)列出本回合登場的審查員;
|
||||
* 攻擊方(步驟 4)與防守方(步驟 6)共用本模板,僅標題不同。
|
||||
* 攻擊方(步驟 5)與防守方(步驟 7)共用本模板,僅標題不同。
|
||||
* 面向欄位經 focusLabel() 轉成「中文(原文)」並列格式。
|
||||
*
|
||||
* @param {Object} params - 留言內容(解構參數)。
|
||||
@@ -166,7 +166,7 @@ function diffComment(rows, ignoredCount) {
|
||||
* @param {string} params.roles[].meta.personality - 角色個性描述;經 cell() 防呆。
|
||||
* @returns {string} 完整留言 Markdown 字串(含 MARK 隱藏標記)。
|
||||
* @remarks
|
||||
* 使用情境:審查流程步驟 4(攻擊方登場)與步驟 6(防守方登場)——
|
||||
* 使用情境:審查流程步驟 5(攻擊方登場)與步驟 7(防守方登場)——
|
||||
* 在各階段開始審查前,把該回合參與的審查員角色、負責面向與個性
|
||||
* 留言到 PR,讓開發者理解後續 findings 是由哪些視角產出的。
|
||||
*/
|
||||
@@ -371,7 +371,7 @@ function issueFindingComment(finding) {
|
||||
* @param {number} ignoredCount - 依 `.reviewignore` 排除的檔案數;大於 0 才顯示「(N 個檔案被排除)」註記。
|
||||
* @returns {string} 完整留言 Markdown 字串(含 MARK 隱藏標記)。
|
||||
* @remarks
|
||||
* 使用情境:審查流程步驟 3 的替代路徑——整理 git diff 時發現
|
||||
* 使用情境:審查流程步驟 4 的替代路徑——整理 git diff 時發現
|
||||
* 過濾後送審清單為空(例如整包變更都被 .reviewignore 排除),
|
||||
* 直接以本留言告知開發者本回合視為審查通過,不再進入
|
||||
* 攻擊方/防守方審查階段。
|
||||
|
||||
Reference in New Issue
Block a user