code-review-checklist 是做什麼的?
全方位的程式碼審查清單,涵蓋功能、安全性、效能與可維護性等面向。
簡介
本清單提供一套系統化的流程,用於在 AI 代理或人工作業中進行程式碼審查。它涵蓋以下關鍵領域:
- 功能正確性:驗證程式碼邏輯與業務需求相符。
- 安全性:檢查常見漏洞,如注入攻擊、認證缺陷。
- 效能:識別可最佳化的瓶頸與資源使用。
- 可維護性:確保程式碼清晰、模組化且易於修改。
使用方式
將此清單作為提示樣板或參考指南,搭配您的 AI 代理(如 Claude Code、Cursor 或 Codex)。審查時逐一檢查下列項目。
代碼審查核對清單
- 功能正確性
- 程式碼是否正確實現需求規格?
- 邊界情況是否已處理?
- 錯誤處理是否完善?
- 安全性
- 是否防範 SQL 注入、XSS、CSRF 等攻擊?
- 認證與授權邏輯是否嚴謹?
- 敏感資料(如密碼、API 金鑰)是否妥善保護?
- 效能
- 是否存在不必要的資料庫查詢或 API 呼叫?
- 迴圈與遞迴是否有效率?
- 快取機制是否已適當運用?
- 可維護性
- 程式碼是否遵循團隊編碼規範?
- 是否有清晰註解與文件?
- 單元測試是否完整且通過?
貢獻
歡迎透過 Pull Request 提交改進或新增項目。請確保變更保持通用性,適用於多種程式語言與框架。