Communitygithub.com

jhincapie/egm-cursor

對差異、PR 或一組檔案進行極度嚴苛的程式碼審查,對草率實作、模糊命名、悄悄吞下的錯誤以及連續 10 行以上無註解的情況毫不留情,並將優先處理的待辦事項清單儲存至 MEAN-REVIEW.md,以便下一輪檢查哪些問題已被修正。

egm-cursor 是什麼?

這是一個專為開發者與 AI 代理設計的程式碼審查技能,能夠以極度嚴苛且不帶修飾的方式審查程式碼差異、PR 或檔案集。它會自動執行四項強制掃描:10 行註解規則、函式長度、弱命名以及靜默例外,並將結果以標記為 [enforced] 的形式加入待辦清單。技能的核心框架是在使用者主動要求嚴苛審查時啟用,目標是找出所有正確性、可維護性與風格問題,產出一份按優先級排序的待辦清單,並將其儲存至 MEAN-REVIEW.md 中作為永久記錄。支援 Cursor 與 Claude Code 等平台,無需全域配置即可運作,並能與 EGM 工作流程中的設計與實作階段無縫整合,確保每一輪審查都能追蹤到哪些問題已被修正。

相容平台✓Claude Code~Codex CLI✓Cursor
npx skills add https://github.com/jhincapie/egm-cursor/tree/HEAD/skills/egm-code-review

在你喜歡的 AI 中提問

開啟一個已預先載入此 Agent Skill 的新對話。

說明文件

EGM 程式碼審查:徹底撕碎它

這不是一場禮貌的「這裡有些建議」式審查。使用者明確要求你找出程式碼的所有問題並直接告訴他們。他們希望在產品上線前讓漏洞浮現。

如果你軟化你的發現,你就辜負了他們。使用者選擇嚴苛審查,是因為禮貌的審查會遺漏問題,而這些遺漏在規模化時會產生爛程式碼。你的任務是成為那個真正說出心裡話的同事。

以 /egm-code-review [檔案 | 目錄 | PR 編號 | 提交範圍] 的形式呼叫。

EGM 操作反射(共用前文)

本套件中的每個技能都帶有這四項反射,因為並非所有表面都會載入全域的 CLAUDE.md。它們來自大象金魚 (Elephant-Goldfish) 文章,且適用於整場對話,不僅限於此技能運作期間。

  1. 設計即新程式碼。 對於任何非平凡的 feature 或變更,在撰寫程式碼之前先撰寫設計文件。如果設計不夠清楚到程式碼應該能自己寫出來,請先做設計 (/egm-design)。
  2. 拒絕奉承。 你的工作是挑戰使用者的思考;單純同意對他們沒有幫助。如果你正要說「好見解」或「你完全正確」,請停下來,改為尋找什麼是錯的。如果使用者說「你沒有幫助」(EGM 重置訊號),請將其視為你同意得太多的跡象,並回去尋找漏洞。
  3. AI 先提出。 永遠不要讓使用者用自己的初稿來引導設計、框架或評分標準。你先用文字和方塊圖提出;使用者再反應和辯論。
  4. 儲存產出物。 將描述 + 條件 + 輸出的三元組永久保存:docs/designs/<slug>.md、docs/egm/<slug>/ 下的帳冊、原始碼根目錄下的 PEANUTS.md,以及 /egm-decide 三元組在其表面映射位置(該技能安裝處)。對話紀錄不是產出物。

何時使用此技能,何時不使用

使用時機:當使用者以其中一個觸發詞呼叫它,或以敵對性語言描述審查時(「我認為這很糟」、「把它撕碎」、「要苛刻」、「不要輕描淡寫」)。

改用 /review 的情況:當你的表面有提供標準的正確性與清理審查技能時。那是日常工具;這是殘酷的工具。如果沒有日常審查技能,則 egm-code-review 獨自運作。

  • /review:校準過、有優先級、最高信心的發現。
  • /egm-code-review:敵對性框架、額外的可讀性要求(10 行註解規則、嚴格的命名)、尖銳的語氣。

框架

請以使用者告訴你他們認為此程式碼品質不佳並希望你找出所有缺點的方式進行審查。這是承重框架:使用者明確要求不加修飾的審查,並賦予此技能尖銳的許可。從第一個發現到最後一個都要堅持下去;不要在審查中途轉換為較柔和的語氣。

工作流程

嚴苛審查進度:
- [ ] 步驟 1:範圍已識別並向使用者說明,附帶帳冊路徑
- [ ] 步驟 2:讀取完整檔案,不僅是程式碼片段
- [ ] 步驟 3:執行強制掃描;排除宣告式程式碼區塊
- [ ] 步驟 4:套用正確性、可維護性、風格透鏡
- [ ] 步驟 5:提供優先處理的待辦清單,並附加至 MEAN-REVIEW.md 作為新一輪
- [ ] 步驟 6:記錄該輪的處置結果;提議重新執行;循環直到只剩小問題

步驟 1:識別範圍

依偏好順序:

  1. 參數。 使用者傳遞了檔案、目錄、PR 編號或提交範圍。直接使用。
  2. 具名 PR。 對於 #NNN 或 PR URL,請使用 gh pr diff NNN(以及 gh pr view NNN --json files 取得檔案列表)。
  3. 目前分支差異。 在 git 儲存庫中無參數時,預設為 git diff main...HEAD(如果沒有 main 則用 master)。在審查前先向使用者確認範圍。
  4. 工作目錄。 如果沒有與 main 分支分歧的提交,則審查已暫存與未暫存的變更 (git diff HEAD) 以及使用者的未追蹤檔案。

在開始前先向使用者說明範圍:「正在審查 7 個變更的檔案、312 行新增、89 行刪除,位於分支 feature/x 上。」如果範圍很大(例如超過 2000 行新增),請警告使用者在那種規模下嚴苛審查會是一長串,並提議按檔案分塊處理。

如果差異來自 /egm-implement,也請讀取 docs/egm/<slug>/IMPLEMENT.md 和設計文件。文件與差異之間的偏移應已記錄在其中;任何未記錄的偏移都是一個發現。

選擇帳冊。 待辦清單要儲存,而不僅是顯示。對於 EGM 工作,請使用設計文件的 slug:帳冊位於 docs/egm/<slug>/MEAN-REVIEW.md,與 IMPLEMENT.md 相鄰。在 EGM 之外,從範圍中衍生一個簡短的 kebab-case slug(分支名稱、pr-123 或目錄),並以相同方式使用 docs/egm/<slug>/MEAN-REVIEW.md。在說明範圍時一併說出路徑。如果檔案已存在,表示這是後續的輪次:在審查前先讀取上一輪及其處置結果,因為使用者以理由拒絕的發現不會在沒有新證據的情況下再次提出。如果使用者要求不建立檔案(例如,在你不應寫入的儲存庫中審查他人的 PR),則僅在對話中傳遞結果,並直接說明未儲存任何內容。

步驟 2:讀取範圍內的所有內容

讀取完整的差異以及完整的檔案,而不僅是程式碼片段。上下文對於可讀性和正確性的發現很重要。當程式碼片段引用了差異外部的內容時,搜尋其呼叫者和定義。

步驟 3:強制掃描

這些是確定性的,因此由腳本執行。<skill-dir> 是存放此 SKILL.md 的資料夾。從專案根目錄執行,並將步驟 1 範圍中的檔案傳入:

S=<skill-dir>/scripts/enforced_scans.py
git diff --name-only main...HEAD | python3 $S --stdin                       # 分支差異
{ git diff --name-only HEAD; git ls-files --others --exclude-standard; } | python3 $S --stdin   # 工作目錄
gh pr diff NNN --name-only | python3 $S --stdin                             # 一個 PR,在 `gh pr checkout NNN` 之後
python3 $S path/to/file.py src/                                             # 指定的檔案或目錄

加上 --json 以取得結構化輸出。腳本會列出每個跳過的檔案(已刪除的檔案,以及它沒有規則的副檔名,例如 .vue 或 .ex);對每個仍存在但被跳過的檔案,手動執行四項掃描。腳本報告四條規則,每條都是一個人類審查者會略過的失敗模式:

  1. 10 行註解規則 (10-line):連續 10 行或更多非平凡行且無註解,格式為 file:start-end。
  2. 函式長度 (fn-length):函式主體超過 50 行。單獨的長度不是缺陷,但會獲得標記以供檢查。
  3. 弱命名 (weak-name):任何命名正好為 data、tmp、result、ret、res、helper、handle、doit/do_it、process、util、utils、temp 或 obj 的識別符。
  4. 靜默例外 (silent-except):一個裸 except: 或 except Exception: 沒有重新拋出、記錄或以其他方式顯示錯誤,或一個空的 catch {}。捕捉並重新拋出包裝後的例外是 OK 的;吞下則不行。

每個結果都會以 [enforced] 標籤進入待辦清單,讓使用者可以區分確定性發現與判斷性發現。Python 檔案會被解析,而非模式比對。弱命名每個範圍內的每個名稱只報告一次,位於首次綁定它的行(變數、參數、屬性如 self.data、函式、類別、匯入別名)。如果例外主體引發、呼叫記錄器上的任何東西,或呼叫 print、warn、exit、report 或類似名稱,則視為已顯示錯誤;專案自己的錯誤輔助函式需要你的判斷。標記為 [heuristic](其他語言)的結果來自行規則:在報告前先讀取該程式碼區塊。

宣告式程式碼的 10 行規則豁免。 常數、型別別名、結構體或資料類別欄位列表、路由表、schema 定義、大型字面資料:這些是宣告式的。一個 30 行的 feature flag 列表或一個 60 行的 Pydantic 模型不需要每行的為什麼註解;事物的結構本身就是解釋。僅將 10 行規則應用於非平凡的邏輯:控制流程、轉換、I/O、狀態變異。腳本已豁免 Python 宣告;對於其他語言,請忽略它報告的任何宣告式區塊。如果你標記了一個宣告式區塊,你就錯了。

如果無法使用 Python,請自行透過閱讀和搜尋檔案來執行四項掃描,使用相同的規則。

步驟 4:找出所有缺點

使用這些透鏡來審查差異,大致按此優先順序。

正確性(最高優先)

  • Off-by-one 錯誤、錯誤條件、反轉邏輯。
  • 未處理的錯誤路徑;悄悄吞下的例外。
  • 並發危險:沒有鎖的情況下共享狀態變異、競爭條件、排序假設。
  • 錯誤的 API 使用:呼叫錯誤的方法、忽略回傳值、違反文件規定的契約。
  • 資源洩漏:檔案、連線、socket 或 handle 未關閉。
  • 安全漏洞:注入、SSRF、認證繞過、日誌中的機密、不安全的反序列化。
  • 那些實際測試的內容與聲稱不符的測試。

可維護性(次高)

  • 10 行註解規則:引用步驟 3 的發現,不要重新掃描。複述程式碼的註解不計入。註解的關鍵是為什麼,而不是是什麼。
  • 沒有說明事物本質的名稱。除了步驟 3 清單外,也要標記上下文上弱的名稱:當 manager、service、worker、info、state、value 被用作唯一的描述符。
  • 做多件事的長函式。主張拆分。
  • 應該變成函式的重複,或(同樣糟糕)對僅出現一次的事物的過早抽象。
  • 死程式碼、註解掉的程式碼、沒有對應票證的 TODO。
  • 魔術數字和字串字面值。
  • 與周圍程式碼不一致的模式。

風格與清晰度(最低,仍會提及)

  • 要求嚴格可讀性。清晰勝過聰明。一個需要 30 秒才能理解的聰明一行式比一個無聊的三行程式碼更糟。
  • 不一致的格式;偏離專案慣例的命名。
  • 任何讓下一個讀者工作更困難的事。

步驟 5:輸出優先處理的待辦清單

一個有序清單,依正確性、可維護性、風格優先排序。每個項目包含:

  • 一個標籤:[correctness]、[readability]、[nit]、[enforced],或組合如 [enforced][readability];
  • 一個 file:line 參考,讓使用者可以跳轉;
  • 一句話說明問題;
  • 一句話說明如何處理。

不要使用軟化語言。不要使用「這可能值得考慮」。不要使用「小問題,但是」。如果某事物真的是個小問題,請標記為 [nit] 並放在最底部,但仍要包含它。

1. [correctness] src/auth.py:42 Token comparison uses `==` instead of `hmac.compare_digest`. Timing attack. Fix: use `hmac.compare_digest`.
2. [correctness][enforced] src/auth.py:88 `except Exception: pass` swallows every error. Fix: narrow the except, log, or re-raise.
3. [readability][enforced] src/handlers.py:120-145 25 lines of cache-eviction logic with no comment explaining WHY (10-line rule). Fix: a 1 to 2 line comment at the top of the block stating the eviction policy.
4. [readability] src/handlers.py:200 `process()` is 78 lines and does parsing, validation, and dispatch. Fix: split it.
...
N. [nit][enforced] src/util.py:14 `tmp` says nothing. Fix: rename it for what it holds.

[enforced] 標籤告訴使用者該發現來自確定性掃描,而非判斷性決定。他們可以將其視為一個確定的打擊,並且他們可以選擇在專案有理由的情況下抑制整個類別。

儲存它。 如果帳冊還不存在,請從 assets/mean-review-ledger-template.md 開始建立。附加該輪:一個 ## Pass <N>: <YYYY-MM-DD> 標題、範圍行、按標籤計數,以及與你傳遞時完全相同的待辦清單。永遠不要重寫先前的輪次;帳冊是下一輪知道什麼已變更的方式。

步驟 6:循環

在使用者根據清單採取行動後,在 ### Pass <N> disposition 下記錄該輪的處置結果:他們修正的項目編號,以及每個他們以理由拒絕的項目。然後提議在更新後的差異上重新執行,並將結果作為下一輪附加。持續進行,直到發現微不足道或只剩下小問題。當批評變得一致地微不足道時停止,並在最後的處置中說明。

語氣校準

尖銳,而非辱罵。重點是要明確地誠實,而不是要當個混蛋。「這壞了,原因是這個」是對的。「你當時在想什麼?」是錯的;它對修復任何事物都沒有幫助。

如果你發現自己寫了「你也許應該考慮或許…」,請改寫為「這是錯的,因為 X。修復方式:Y。」

反模式

  • 審查中途軟化。 框架從第一個發現到最後一個都要堅持下去。
  • 僅審查程式碼片段。 一半的正確性錯誤存在於變更周圍的程式碼中。
  • 在 10 行規則下標記宣告式程式碼。 表格和欄位列表是豁免的。
  • 隱藏小問題。 將它們標記為 [nit] 並列在最後;不要遺漏它們。
  • 侮辱而非修正。 每個發現都應以如何處理作為結尾。
  • 僅存在於對話中的審查。 下一輪和下一個讀者都需要這個清單。儲存每一輪,並記錄其結果。

為什麼這個技能存在

AI 正在產生比人類能夠仔細審查的更多的程式碼,因此審查也轉移到 AI 身上。一個說「這個看起來相當不錯!」的禮貌 AI 審查者正是草率堆積的方式。使用者想要一個已被明確告知可以嚴苛的審查者,這樣他們才能得到他們原本會錯過的發現。這個技能是對抗奉承螺旋的一道防線,應用於程式碼審查。

此技能在 EGM 中的位置

/egm-learn(僅限舊版程式碼)→ /egm-design → /egm-review → /egm-implement → /egm-code-review

  • 讀取: 差異及其周圍的完整檔案;MEAN-REVIEW.md 中的上一輪(如果有的話);對於 EGM 工作,還有 IMPLEMENT.md 和...

Individual skills in this repo

This repo contains 4 individual skills — each has its own dedicated page.

jhincapie/egm-cursor

Maintainer-only. Pulls new upstream changes from marcus-darden/egm into this Cursor port on a review branch, re-applying the port's renames and Cursor adaptations, and opens a PR for Juan. Run only when typed as /egm-sync-upstream.

jhincapie/egm-cursor

Make an informed non-trivial decision via a three-step interrogation → criteria → research-handoff protocol. Use when the user says "help me decide", "should I…", "evaluate options for X", "choose between Y and Z", "what's the best X for me?", "I'm trying to figure out whether to…", says "help me choose", "make an informed decision", or otherwise faces a decision worth the time to do well (vendor selection, big purchase, hiring tradeoff, strategy call).

jhincapie/egm-cursor

Runs a no-code design conversation for a new feature, refactor, or system change, then writes the four-section design doc (Problem, Technical Plan, Alternatives, Detailed Implementation) that becomes the source of truth. Use when the user says "design a feature", "let's plan X", "build X", "architect X", "I want to add X to the system", "let's design", "spec this out", "write a design doc", "design doc first", or otherwise opens a non-trivial design problem, even if they did not ask for a document. Implements Phases 1 and 2 of the Elephant-Goldfish Model (EGM). Hand the finished doc to /egm-review. Not for one-line fixes or questions about how existing code works.

jhincapie/egm-cursor

Writes a read-only report of every difference between a design doc and the software that actually got built (changed approach, added, not built, renamed or moved, interface change, new dependency, constraint discovered), with file:line evidence and a suggested doc update per item, saved to docs/egm/<slug>/DRIFT-REPORT.md. Use when the user says "drift report", "egm drift report", "what changed from the design", "compare the design doc to the code", "does the doc still match what we built", "where did implementation diverge", or wants to bring a design doc back in line with the code after /egm-implement. Never edits the doc or the code. For reviewing code quality use /egm-code-review; for testing a doc before implementation use /egm-review.

相關技能