hyhmrright/brooks-lint:README 來源編輯指南
根據 README、倉庫資料與授權整理 hyhmrright/brooks-lint 的安裝與核驗路徑。
專案定位
hyhmrright/brooks-lint 的 README 將專案描述為「AI code reviews grounded in 12 classic engineering books , decay risk diagnostics with book citations, severity labels, and 6 analysis modes including full-sweep auto-fix」。本文只整理倉庫可直接核對的內容,不把 star、Fork 或宣傳語當成品質證明。README 在「README」下寫到:> "The bearing of a child takes nine months, no matter how many women are assigned." > , Frederick Brooks, The Mythical Man-Month (1975)。這說明的是專案邊界,不是已完成的生產驗證。
適用場景
從 README 的「Roadmap」與相關條目,可以先判斷它是否處理你的實際問題:v0.5,v0.7: Test Quality Review, Mermaid dependency graph, .brooks-lint.yaml, 10-book expansion。若需求不同,不應只因專案熱度就採用。本文保留原始專案名、命令與元件名,方便回到一手來源核對。 README 另外列出一項可核對的資訊:v0.2,v0.4: Plugin infrastructure, six-book framework, decay risk dimensions, benchmark suite。這類原文條目可用來設計試跑步驟,但不能取代實際環境測試。
運作方式
README 將運作方式分散在「README」等段落。可確認的線索包括:Most code quality tools count lines and cyclomatic complexity. brooks-lint goes deeper , it diagnoses your code against six decay risk dimensions synthesized from twelve classic engineering books, producing structured findings with book。本文不把未寫出的架構、效能或安全邊界補成結論;真正的執行鏈仍要配合目錄、設定檔與版本標籤檢查。
安裝與第一次執行
第一次安裝應從 README 指出的入口開始。目前可核對的命令是: # Claude Code /plugin marketplace add hyhmrright/brooks-lint /plugin install brooks-lint@brooks-lint-marketplace # Any other Agent Skills platform , Cursor · Codex · Gemini · Copilot · Windsurf · OpenCode · Kiro · … curl -fsSL https://raw.githubusercontent.com/hyhmrright/brooks-lint/main/scripts/install.sh | bash -s -- <platform> 如果倉庫沒有命令,本文不會自行編造步驟,而是建議先閱讀「The Twelve Books」,確認系統依賴、預設埠與首次初始化。
設定與日常使用
日常使用取決於專案文件。README 的「README」段落提到:For the full source-to-skill mapping, including exceptions and false-positive guards, see skills/shared/source-coverage.md.。設定檔、環境變數、權限與資料目錄只在來源明確時才會記錄;沒有寫出的預設值,應在測試環境驗證並保留回滾副本。 同一部分也提到:v0.8,v0.9: Independent skill architecture; step validation, auto-diff scope, /brooks-health, trend tracking, triage mode, --fix remedies, GitHub Action。