工程開發
pr-review avatar

pr-review

Schmock 專案專用的自動化 PR 審查工具,確保 BDD 測試覆蓋率、程式碼品質、TypeScript 標準及 Commit 規範。

簡介

pr-review 技能是 Schmock 生態系統中的專業品質守門員,旨在為每個傳入的合併請求 (Pull Request) 強制執行嚴格的專案標準。它專為需要維護 API Mocking、插件開發和框架適配器高可靠性的維護者和貢獻者而設計。透過自動化評估流程,它減少了檢查行為文件、型別安全和包完整性所需的認知負擔,確保程式碼庫標準在所有儲存庫中保持一致。

  • 透過確保每個功能或錯誤修復都有對應的 .feature 場景和匹配的 .steps.ts 定義來驗證 BDD 覆蓋率。

  • 透過稽核 'any' 型別濫用、泛型錯誤使用以及自訂插件中的潛在安全性漏洞(如 XSS 或注入攻擊)來強制執行 TypeScript 嚴格模式。

  • 審查架構模式,檢查是否過度設計或存在過早抽象化,並驗證是否符合 Schmock 專案約定。

  • 檢查 Commit 歷史記錄以確保符合 Conventional Commits 格式(feat, fix, chore),從而保持專案歷史整潔且易於維護。

  • 使用如 publint 和 attw 等先進工具檢查套件完整性,以確保正確的匯出、相依性管理和對等相依性範圍。

  • 提供結構化且基於嚴重程度的建議(Blocker, Suggestion, Nit),協助貢獻者快速識別並解決高優先級問題。

  • 此技能需要合併請求編號 (PR number) 作為啟動流程的主要參數。

  • 在內部使用 GitHub CLI (gh) 指令來提取差異 (diffs) 和 PR 元數據,因此需要使用 GitHub Token 進行身份驗證。

  • 要求專案處於可執行 bun 指令進行測試和驗證的狀態(例如 bun test:all, bun check:publish)。

  • 輸出結構被劃分為明確定義的類別,以防止審查人員遺漏關鍵性的失敗點。

  • 使用者應確保擁有儲存庫的必要權限以執行自動化診斷步驟,因為該技能會在與 PR 相關聯的分支上執行測試。

倉庫統計

Star 數
1
Fork 數
0
Open Issue 數
5
主要語言
TypeScript
預設分支
main
同步狀態
閒置
最近同步時間
2026年5月3日 下午08:37
在 GitHub 查看