Community程式設計與開發github.com

italixcs/repo-cleaner

改善 GitHub 倉庫的公開展示與可發現性,涵蓋 README 結構、橫幅、真實展示案例、準確徽章、安裝指南、文件導覽、About 文字、主題標籤及社交預覽素材。適用於倉庫改造、README 重新設計、上線發表或倉庫能見度審查。可跨應用程式、工具、函式庫及 AI 代理技能使用,並針對技能發佈提供額外指引。請勿用於應用程式程式碼清理、重構或成長保證。

repo-cleaner 是什麼?

這項技能旨在幫助開發者全面改善 GitHub 倉庫的公開呈現與可被發現性,而非修改應用程式的行為或程式碼。它提供一套結構化的流程,從建立工作簡報開始,審查使用者從發現到初次成功使用的完整路徑,再到建立一致的 README 與視覺資產,並透過誠實的元資料(如 About 文字、主題標籤、社交預覽圖片)提升可發現性。 該技能特別適合用於倉庫改頭換面、README 重新設計、產品發表前的準備,或是進行倉庫能見度稽核。它支援 GitHub 原生風格的文件與徽章,並能處理應用程式、工具、函式庫以及 AI 代理技能等多種專案類型。對於技能類倉庫,它會特別驗證 `SKILL.md` 與相關資源的存在與正確性。 這套方法強調事實為基礎的驗證,避免僅憑臆測行事,並在最後階段提供完整的變更摘要與驗證報告。它不會承諾流量、星星數或排名,也不會在未經授權的情況下變更倉庫能見度或提交推廣清單。

相容平台✓Claude Code~Codex CLI~Cursor
npx skills add https://github.com/italixcs/Repo-cleaner/tree/HEAD/skills/repo-cleaner

Installed? Explore more 程式設計與開發 skills: steipete/bluebubbles, steipete/eightctl, steipete/blucli · View all 6 →

在你喜歡的 AI 中提問

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

說明文件

Repo Cleaner

讓一個好專案的目的、實證與第一個有用操作易於被發現。改善倉庫的表面層,同時保留應用程式的行為。

1. 建立工作簡報

  • 識別倉庫、目標受眾、期望成果、語言,以及是審查還是實作。重用已授予的授權。
  • 閱讀適用的說明文件、README、相關指南、授權條款、套件/技能清單、範例、素材,以及當前的 GitHub 元資料。僅在必要時檢查原始碼以驗證宣稱與命令。
  • 檢查工作目錄,並保留不相關的變更、現有的授權條款與歸屬資訊。除非明確授權變更能見度,否則保持能見度不變。
  • 針對遺漏的事實或具重大影響的選擇提出有重點的問題:受眾、衝突的品牌形象、無法取得的存取權、不確定的安裝方式,或有意義的品牌重塑。根據專案本身解決常規的版面配置選擇。在等待回覆時繼續獨立工作;不要為了避免提問而編造事實。
  • 如果工作簡報有幫助,可使用 assets/repo-brief.md;不要將其添加到每個目標倉庫中。

2. 審查讀者路徑

閱讀 references/audit-and-validation.md。追蹤發現 → 第一螢幕 → 實證 → 安裝 → 首次成功 → 深入協助。

列出少數幾個影響最大的缺口,並附上證據與優先順序。將事實問題與品味選擇分開。包含需要移除的雜亂內容。區分遺漏的資訊與你的工具無法取得的資訊。如果是純審查工作,請回傳發現結果與具體建議,不要編輯檔案或設定。

3. 建立一致的展示

閱讀 references/readme-and-visuals.md。預設使用 GitHub 原生的文件樣式、標準扁平徽章、一般導覽連結,以及專案特定的實證。除非被要求,否則不要重複使用作者個人檔案的美學風格。閱讀 references/readme-patterns.md 以選擇結構或向參考倉庫學習。選擇一個適合該專案的方向,然後實作最少一組能讓它易於理解與使用的素材與文件。

  • 以具體的承諾、有用的視覺實證,以及清晰的第一步操作開頭。將重要資訊保留為真實文字。
  • 僅在有用時加入橫幅;優先選擇具體任務、實際輸出或有用的展示,而非裝飾性的品牌宣傳;從實際輸出中擷取螢幕截圖。準確標示概念、測試用固定資料、重建結果與本機預覽。
  • 加入節制的徽章列,包含可運作的目標連結與有根據的宣稱。
  • 在 README 中保留最短的、經過驗證的安裝與使用範例。連結較長的平台指南、疑難排解與範例,但不要重複它們。
  • 組織公開文件與素材,但不要移動應用程式原始碼或改變執行時期/建置行為。移動文件時更新連結。
  • 讓文件深度與專案匹配。移除通用的行銷文案、重複的標語、強加的機能表格、填充用的章節、徽章牆、裝飾性圖表,以及空目錄層級。保留專案特定的語氣。

對於技能倉庫,請驗證可安裝的資料夾包含 SKILL.md 與所有被引用的資源。將該套件與公開行銷文件分開。根據主機記錄確切的發現路徑、呼叫範例、必要條件與工具需求。說明每個路徑是否經過執行時期測試、是否與主機文件對照檢查,或僅能手動使用。不要僅憑一個純技能資料夾就推斷有外掛程式、市集上架或通用代理支援。

4. 使用真實元資料改善可發現性

閱讀 references/github-discovery.md。提出簡潔的 About 文字、有用的真實首頁(若可用)、有證據支援的主題標籤,以及社交預覽素材。在套用前驗證當前的 GitHub 限制。

使用適當的工具套用已授權的設定,並保留相關的現有數值。如果工具缺少某項操作,請準備確切的數值與設定連結。區分已套用、已準備與已封鎖。已提交的元資料檔案或社交圖片並不會設定 GitHub。未經授權不得變更能見度、聯絡他人或提交促銷清單。

5. 驗證與交接

使用審查參考驗證讀者路徑:連結與錨點、圖片、安全的快速入門、真實的徽章與相容性、桌面/行動版、淺色/深色主題、最終差異(diff)與設定讀回(read-back)。明確回報工具或網路限制。儲存來源素材,以便後續更新仍可行。

僅在獲得授權時進行提交或推送,並遵循目標倉庫的工作流程。確認目標與最終修訂版本。總結變更、驗證結果、未套用的設定,以及少數剩餘的操作。不要承諾流量、星星數、排名或未經測試的支援。

相關技能