Communitygithub.com

dubbl-a/house-rules

查詢某主題對應的內部規範(house rule),僅搜尋 `.house/INDEX.md`,不讀取規則本體;適用於「此主題的規範是什麼」以及「對此主題是否有內部慣例」。

house-rules 是什麼?

此技能為開發者與 AI 代理提供一種輕量、精準的方式,來查詢專案中關於特定主題的內部規範(house rule)。其核心設計理念是透過唯讀一份精簡的索引檔 `.house/INDEX.md`,避免載入龐大的規則檔案集合,藉此大幅降低查詢成本。技能支援的查詢類型包括「某主題的規範是什麼」或「是否有內部慣例」,並會回傳所有匹配的規則條目(包括檔案路徑、標題與索引摘要),確保不會遺漏任何相關規定。此外,技能內建多種例外處理機制,例如當索引不存在、無匹配結果、索引過時或用戶要求查看完整規則文字時,皆有對應的明確指示。此技能可與 Claude Code、Cursor、Codex 等支援自訂技能的 AI 代理平台整合,適用於任何已採用 House 規則管理系統的軟體開發專案,幫助團隊快速查閱一致且權威的內部規範,避免重複造輪或違反既定慣例。

相容平台✓Claude Code~Codex CLI~Cursor
npx skills add https://github.com/dubbl-a/house-rules/tree/HEAD/plugins/house/skills/conventions

在你喜歡的 AI 中提問

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

說明文件

內部規範查詢(House conventions lookup)

此技能回答一個問題:針對某主題,內部規範(house)怎麼說,以及規範檔案位於何處。它讀取渲染步驟產生的索引,從不直接讀取規則檔案本身。這正是索引存在的意義:查詢應該只耗費一個小檔案,而不必讀取 repo 中的所有規則檔案。

預設流程

  1. 讀取 repo 根目錄的 .house/INDEX.md。請勿開啟 .claude/rules/**、docs/handbook/** 或 plugins/house/modules/**/rules/** 下的任何檔案來回答問題。索引包含每個導入規則的檔案、標題以及一行摘要,這本身就足以回答大多數查詢。
  2. 在索引中搜尋其檔案、標題或一行摘要與問題相符的條目。根據語義和關鍵字進行比對,而非精確字詞。關於提交訊息的問題,即使字詞不同,也應比對到關於提交的標題。
  3. 列出所有匹配的結果,而非僅第一個。一個主題可能合理存在於多個規則檔案中(例如,文件規則和工程規則都可能涉及同一問題),遺漏真實匹配會因省略而導致答案錯誤。
  4. 對於每個匹配,照實報告規則檔案路徑、標題以及索引的一行摘要。指出引用位置(file#slug),讓用戶可以自行開啟真實規則以查看完整文字。
  5. 在此停止。不要根據記憶或本次工作階段先前讀取的內容,對規則本體進行改寫、擴充或重構。索引的一行摘要就是此技能給出的答案;連結的規則檔案才是完整規則所在。

例外處理

  • repo 中沒有 .house/INDEX.md。 直接說明此 repo 尚未採用 house,或是使用的版本是在索引存在之前渲染的。不要根據訓練知識、CLAUDE.md 的快速瀏覽或其他 repo 的規則來猜測答案。在此停止。
  • 索引中沒有任何內容與問題匹配。 直接說明 house 對此主題沒有相關規則。不要自己發明規則,也不要將鬆散相關的條目延伸來回答它並未涵蓋的問題。
  • 索引看起來過時了。 列表中某個標題不再出現在其規則檔案中,或列表中某個規則檔案完全缺失。說明索引看起來過時了,指出過時的內容,並建議執行 /house-rules:sync。但仍需回報索引中最佳匹配的結果;索引過時是答案的一個注意事項,而非隱瞞答案的理由。
  • 用戶想要完整的規則文字,而不只是知道規則在哪裡。 只有在這種情況下,才讀取索引指向的那一個規則檔案。絕對不要為了這件事而開啟整個規則集。在找到索引匹配之後,再讀取單一檔案,而不是在此之前。

禁止事項

  • 不要為了回答查詢而載入所有規則檔案。那正是索引存在要避免的成本。
  • 不要根據本次工作階段稍早讀取的規則檔案來回答問題。每次都要重新檢查索引;同步可能會改變索引在會話期間的內容。
  • 不要從此技能內部編輯 .house/INDEX.md、.claude/rules/house/** 或其他任何受管理的檔案。對受管理檔案的本地編輯屬於 /house-rules:sync 的拒絕流程,而非查詢。
  • 當索引對所問問題沒有匹配時,不要捏造內部規範。
  • 不要將此變成一個選單。直接回答被問到的問題;只有當問題本身廣泛到涵蓋多個候選模組時,才列出所有候選模組。

Individual skills in this repo

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

相關技能