Community生產力與協作github.com

Luijaa/web-template

在開啟或更新 Pull Request 前,執行完整的 Pre-PR 檢查清單(make check、密碼掃描、文件、差異審查)。請在建立 PR 前或被詢問工作是否就緒時使用。

web-template 是什麼?

此技能為開發者提供一套自動化的 pre-PR 檢查流程,確保每次提交的程式碼品質、安全性與文件完整性。支援 Claude Code、Cursor 等多種 AI 代理平台,透過執行 12 項檢查步驟,包括 `make check` 編譯與測試、機密資訊掃描、僅限相關檔案的差異審查、環境變數範本一致性、相依性授權驗證、資料庫遷移可逆性、文件更新、程式碼審查、 Conventional Commits 規範、PR 描述格式,以及 UI 國際化與主題相容性。若任一檢查未通過,技能會阻止 PR 開啟並要求修正或報告阻塞原因,大幅提升協作效率與專案穩定性。

相容平台✓Claude Code~Codex CLI~Cursor
npx skills add https://github.com/Luijaa/web-template/tree/HEAD/.agents/skills/pre-pr-check

Installed? Explore more 生產力與協作 skills: steipete/gemini, steipete/gh-issues, steipete/skill-creator · View all 6 →

在你喜歡的 AI 中提問

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

說明文件

Pre-PR 檢查

執行所有步驟,並以表格報告 通過/未通過 狀態,附上證據(指令與簡要結果)。

  1. make check 必須全部通過(docs-check、lint + SAST、test、build、license)— 但以下兩種情況例外:

    • 僅文件型 PR(docs(design): …、ADR、docs):只需 make docs-check 通過即可
    • 尚未選定技術棧的 repository(目標顯示 not configured — ADR-0001 尚未 accepted):該目標回報為 N/A(尚未設定),既不算通過也不算失敗原因 — 請勿修改 recipe 讓其 exit 0 以強制通過

    另外,若變更影響使用者可見內容(需新增/修改 e2e 測試)請執行 make e2e;若觸及 middleware、header、cookie、錯誤頁面或新路由,請執行 make dast

  2. git diff origin/main...HEAD --stat — 確認只觸及與任務相關的檔案,無遺漏的產出物(build output、.env、個人檔案)

  3. 遺留的暫存日誌:git diff origin/main...HEAD | grep -n '\[DBG-' 不得找到任何結果(fix-bug 第 3 項)

  4. 在 diff 中搜尋機密資訊:git diff origin/main...HEAD | grep -nEi '(api[_-]?key|secret|token|password|BEGIN .*PRIVATE KEY)' — 若找到則停止並通知

  5. 新的環境變數都已加入 .env.example

  6. 新增/升級的相依性(查看 lockfile、go.mod、Dockerfile FROM 的 diff):版本與授權需符合 docs/dependencies.md,並在 PR 描述中註明

  7. 新的資料庫遷移(如有)必須可執行且可回滾

  8. 文件:README、docs、ADR(docs/adr/)需根據變更內容更新;領域新詞需放入 CONTEXT.md,且程式碼中的名稱需與 CONTEXT.md 一致

  9. 根據 review 技能進行程式碼審查(Claude Code:使用子代理 reviewer;其他代理:讀取 .agents/skills/review/SKILL.md 後自行檢查 diff),並處理所有「必須修正」的項目

  10. commit message 需符合 Conventional Commits 規範,且分支名稱不得為 main

  11. PR 描述需包含 Closes #<issue>(若無 issue 請先建立),以及 ## CHANGELOG 標題(類別 + 一行繁體中文的使用者視角說明,或使用 -)— 請勿直接修改 CHANGELOG.md(參考 docs/release.md)

  12. 若觸及 UI:不得有硬編碼文字,所有語言的 key 必須完整,不得有直接使用的顏色值,並確保在 th/en 及 light/dark 主題下皆正常(參考 docs/ui.md)

若任一項檢查未通過,請勿開啟 PR,應先修正問題或回報卡關原因。

Individual skills in this repo

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

相關技能