工作室規範(TinyCorn Studio 標準)
適用於工作室的所有 repo/tool,從初始化到維護階段。
語言
- 與用戶溝通:繁體中文。
- 程式碼、識別碼、commit 訊息、分支名稱:英文。
- README、CHANGELOG、發佈說明:繁體中文。
最小化儲存庫結構
<repo>/
├── README.md # 必備
├── CHANGELOG.md # 必備(遵循 Keep a Changelog)
├── LICENSE # 通常為 MIT
└── .gitignore # 必備
README.md 必須包含以下章節
- 介紹(1-2 句話,說明工具用途及目標用戶)
- 系統要求
- 建置 / 執行方式
- 主要功能(依分類)
- 快捷鍵(若有 UI)
- 架構 / 目錄結構
- 設定(UserDefaults、環境變數、設定檔等)
- 已知限制
- 版本歷史(摘要,詳細內容請見 CHANGELOG)
- 下載(指向最新的 GitHub Releases 連結 — 請勿將安裝檔置於 repo 中)
Git
- 最小
.gitignore內容:.build/、dist/、node_modules/、.DS_Store、以及建置時自動生成的資源目錄。 - 請勿提交:安裝檔(DMG/ZIP)、建置輸出、機密/Token。
- Commit 訊息:一行、英文命令式、完整描述功能或修復內容。例如:
Add folder view to Changes tab。 - 以每個完整功能為單位進行提交;僅在用戶要求或確認功能完成後才提交。
- 分支:
main必須保持可發布狀態;功能開發應在獨立分支上進行,完成後使用--ff-only合併。 - 版本號:採語意化版本(SemVer),僅在單一位置宣告(例如
make-app.sh中的VERSION),不分散在多個檔案中。
文件
- README 與 CHANGELOG 必須與功能開發同時更新(不可事後補上)。
- 每個版本發布都要有:annotated 標籤
vX.Y.Z以及包含繁體中文版發佈說明的 GitHub Release(請參閱release-flow技能)。 - 複雜的設計決策應記錄在程式碼中,或 README 的「架構」章節中。
品質
- 在回報完成前:重新建置/測試,並使用真實資料或沙盒環境進行驗證。
- UI:應用前必須先預覽(請參閱
ui-preview-first技能)。 - 禁止對用戶的真實資料進行寫入/提交測試 — 請使用沙盒複本。
- 測試完成後必須清理沙盒/暫存目錄,不留垃圾在 repo 中。
新儲存庫檢查清單
-
git init+ 標準.gitignore - 符合上述結構的 README
- CHANGELOG 中新增
[0.1.0]區塊 - LICENSE(MIT)
- 建置腳本(make-app.sh 或等效檔案)+ DMG/安裝程式
- 設定 GitHub 遠端儲存庫並推送
main - 首次發布,附帶安裝檔
- 已學習
release-flow技能,供後續使用