repo-onboarding-skill 是做什麼的?
一個將不熟悉的程式碼倉庫轉換為簡潔的架構圖、設定指南和優先任務清單的 Codex 技能。
功能
- 架構圖:自動分析專案結構,產生涵蓋主要模組、目錄與檔案依賴關係的概覽。
- 設定指南:根據
README.md、Dockerfile、Makefile等常見設定檔,提煉出最小化且可立即執行的開發環境設置步驟。 - 優先任務清單:辨識常見的入門障礙(如缺少環境變數、未完成的指引),並列出建議優先處理的事項。
使用方式
- 在 Codex 環境中載入此技能。
- 指定目標儲存庫(例如透過 URL 或本機路徑)。
- 技能將自動產生上述三項輸出,並以 Markdown 格式呈現。
支援平台
- Codex(主要平台)
- 未來可能擴展至其他 AI 代理工具(如 Claude Code、Cursor)。
相依性
- 目標儲存庫應具備基本的專案描述(如
README.md)。 - 如需完整分析,建議目標儲存庫至少包含一個建置工具或設定檔。
輸出範例
# [專案名稱] 架構圖
## 核心模組
- `src/`:應用程式邏輯
- `controllers/`:API 請求處理
- `models/`:資料庫模型
- `config/`:應用程式設定
## 設定指南
1. 複製 `.env.example` 為 `.env`。
2. 執行 `make install`。
3. 執行 `make run`。
## 優先任務清單
- [ ] 檢查 `.env` 中的 `DATABASE_URL` 是否正確。
- [ ] 確認 `requirements.txt` 中的相依性是否安裝成功。
貢獻
歡迎提交 Issue 與 Pull Request。請遵循專案內建的貢獻指南。