Community写作与编辑github.com

tinycorn-studio/agent-skills

TinyCorn Studio 的统一约定,适用于所有仓库/工具(新项目创建、仓库初始化、README、CHANGELOG、.gitignore、提交信息、文档、项目结构)。在开始新项目/工具、初始化仓库、编写文档或询问提交/CHANGELOG/gitignore 约定时使用。也用于检查现有仓库是否符合标准。

agent-skills 是什么?

该技能为 TinyCorn Studio 的所有仓库和工具提供了一套统一的约定和最佳实践,覆盖从项目初始化到日常维护的全流程。它详细规定了沟通语言(与用户使用越南语,代码和提交信息使用英语)、最小仓库结构(包括必选文件如 README.md、CHANGELOG.md、LICENSE 和 .gitignore)、Git 工作流(如基于特性分支、SemVer 版本管理、单行英文提交信息)、文档编写要求(如 README 和 CHANGELOG 需与特性同步更新)、以及质量保障措施(如构建后验证、UI 预览、沙盒测试)。该技能适用于各种 AI Agent 平台,帮助开发者快速启动符合 Studio 标准的新项目,并确保现有仓库的一致性与可维护性。它通过提供一个清晰的检查清单(如新仓库初始化清单)和详细的模板说明,降低了项目混乱和重复劳动的风险。

兼容平台~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 的新对话。

文档

Studio 约定(TinyCorn Studio 标准)

适用于 Studio 的 所有仓库/工具,从初始化到维护的全过程。

语言

  • 与用户交流:越南语。
  • 代码、标识符、提交信息、分支名称:英语。
  • 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 的链接 — 不要将安装文件留在仓库中)

Git

  • 最小 .gitignore 内容:.build/、dist/、node_modules/、.DS_Store、构建时自动生成的资源目录。
  • 禁止提交:安装文件(DMG/ZIP)、构建输出、密钥/令牌。
  • 提交信息:单行、祈使语气、英语、完整描述功能/修复。例如: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 技能)。
  • 不要对用户的真实数据进行写入/提交测试 — 使用沙盒副本。
  • 测试完成后必须清理沙盒/临时文件,不要在仓库中留下垃圾文件。

新仓库检查清单

  • 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.

相关技能