Community寫作與編輯github.com

tinycorn-studio/agent-skills

TinyCorn Studio 的通用規範,適用於所有 repo/tool(建立新專案、初始化 repo、README、CHANGELOG、.gitignore、commit message、文件、專案結構)。在開始新專案/工具、初始化儲存庫、撰寫文件,或詢問關於 commit/changelog/gitignore 慣例時使用。也可用來檢查現有 repo 是否符合標準。

agent-skills 是什麼?

此技能定義了 TinyCorn Studio 所有儲存庫與工具的統一規範與最佳實踐。其主要目的是確保專案從初始化到維護的整個過程中,保持一致性、可維護性與高品質。它涵蓋了專案結構、Git 工作流程、文件撰寫、編碼品質與發布流程等層面。支援與 AI 代理(如 Claude Code、Cursor、Codex 等)協作的開發環境,當用戶開始新專案、初始化儲存庫、撰寫或檢查文件,或詢問關於 Git 慣例(如 commit 訊息、changelog 格式、.gitignore 規則)時,系統會依據此技能內容提供指導。技能以 SKILL.md 文件的形式存在,明確說明了語言使用規則、最小化 repo 結構、必備的 README 章節、Git 操作細節(如 commit 訊息為英文命令式、基於功能的合併策略)、文件同步更新的要求,以及新專案的完整檢查清單。本質上,它是一個強大的專案初始化與維護指南,可作為開發代理的專用 prompt 來減少認知負擔,確保所有專案都從同一個起點開始,並遵循相同的標準。

相容平台~Claude Code~Codex CLI~Cursor
npx skills add https://github.com/tinycorn-studio/agent-skills/tree/HEAD/skills/studio-conventions

Installed? Explore more 寫作與編輯 skills: steipete/notion, langchain-ai/langchain, bytedance/podcast-generation · View all 6 →

在你喜歡的 AI 中提問

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

說明文件

工作室規範(TinyCorn Studio 標準)

適用於工作室的所有 repo/tool,從初始化到維護階段。

語言

  • 與用戶溝通:繁體中文。
  • 程式碼、識別碼、commit 訊息、分支名稱:英文。
  • README、CHANGELOG、發佈說明:繁體中文。

最小化儲存庫結構

<repo>/
├── README.md          # 必備
├── CHANGELOG.md       # 必備(遵循 Keep a Changelog)
├── LICENSE            # 通常為 MIT
└── .gitignore         # 必備

README.md 必須包含以下章節

  1. 介紹(1-2 句話,說明工具用途及目標用戶)
  2. 系統要求
  3. 建置 / 執行方式
  4. 主要功能(依分類)
  5. 快捷鍵(若有 UI)
  6. 架構 / 目錄結構
  7. 設定(UserDefaults、環境變數、設定檔等)
  8. 已知限制
  9. 版本歷史(摘要,詳細內容請見 CHANGELOG)
  10. 下載(指向最新的 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 技能,供後續使用

Individual skills in this repo

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

相關技能