agentleFS
Suge8Suge8/friedbun/skills/development/project-setup/SKILL.md

project-setup

Skill12 starsChanged 6 days agoMITView on GitHub

项目体检:新项目开工、半途补缺、开源前检查或“这个项目缺什么”。盘点文档骨架、工单约定与验证链,报告缺口,确认后补齐。

48 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use creative-writing-craft, creative-writing-muse and 10 more.

Other files people use alongside this one.

Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
  • Abdullokh-NSkill

    creative-writing-craft

    Справочник ремесла: проза, сцена, стиль, голос. Загружать, когда нужно знание "как писать", а не режим производства.

    Also in 3 projects that use this

  • Abdullokh-NSkill

    creative-writing-muse

    Точка входа в набор скилов для длинной прозы. Включается, когда автор просит спланировать, написать, продолжить, переписать или разобрать художественный текст — роман, повесть, цикл рассказов. Ведёт маршрут от замысла к готовому куску и держит базу знаний проекта.

    Also in 3 projects that use this

  • badgidsSkill

    character-sim

    Pressure-test a character by speaking or reasoning strictly from that character's current voice, goals, relationships, emotional pressure, and knowledge boundary without creating canon by accident.

    Also in 3 projects that use this

  • jpsweeney97Skill

    writing-principles

    Enforces writing principles for instruction documents (SKILL.md, skill supporting files, subagents, CLAUDE.md). Use when writing, reviewing, or editing any file in **/skills/**/*.md, **/agents/*.md, or **/CLAUDE.md. Triggers on skill creation, skill file updates, CLAUDE.md changes, subagent authoring, or instruction document review.

    Also in 3 projects that use this

  • ItsSidharthaSkill

    story-planning

    Collaborative planning skill for a GitHub issue. Takes issue content and codebase context as input. Runs an iterative clarification loop until the user explicitly agrees to a plan, then saves it to docs/<story_number>/plan.md. Used by the user-story-implementation skill — load this skill at the start of Phase 1 and follow it completely before returning to the orchestrator.

    Also in 3 projects that use this

  • badgidsSkill

    story-review

    Diagnose existing prose at a chosen editorial level, from whole-story and developmental problems through scene, line, copy, and proof passes, without rewriting until the diagnosis is accepted.

    Also in 3 projects that use this

  • +4 more from Abdullokh-N

The file

Files
SKILL.md

项目体检

1. 盘点(只读)

技术栈与任务运行器、有无 UI、开源信号(LICENSE、公开 remote、用户说要开源)、git remote 是否 GitHub、团队或多个 agent 是否用 issue 分工,以及现有文档:AGENTS.md、WORDS.md、README、CONTRIBUTING、SECURITY、CHANGELOG,和遗留的 CONTEXT.md、docs/adr/、DESIGN.md。

2. 体检表

输出一张表:✓ 已有 / ✗ 缺 / — 不适用,缺的附一行推荐动作。

项何时需要内容与位置
AGENTS.md所有项目根目录;地图:命令入口、代码看不出的约束、条件指针
WORDS.md出现要禁用的近义词或易混概念时根目录;格式见 writing-for-agents「术语表 WORDS.md」
工单约定团队或多个 agent 用 GitHub issue 分工时写进根 AGENTS.md,见下
验证链所有项目达到 references/toolchains.md 的「合格验证链」;不达标时推荐动作按该文件「建链的最小形状」写到能直接交给 agent
LICENSE、用户向 README要开源时根目录
CONTRIBUTING、SECURITY要开源时.github/,英文

文档只写代码看不出的理由、跨模块命名和外部操作步骤。遗留的 CONTEXT.md、docs/adr/、DESIGN.md 报告其中与代码重复的部分,推荐迁移:理由写到决策处注释或 AGENTS.md,术语改为 WORDS.md,设计取值以 token 与 lint 为准。已有文档不重写,只报告与现状脱节处;同一事实只留一份。

内部文档用中文;README 跟随目标用户与既有约定,多语言版本各自成文件并在顶部互链。

3. 补齐

用户确认后再写:AGENTS.md、WORDS.md 与工单约定内容全部来自盘点到的事实,不编造;README 与营销文案按项目事实起草,用 writing-for-humans;CHANGELOG 归 ship。

工单约定

写进根 AGENTS.md,标签沿用 gh label list 已有的:

- 工单:动手前 `gh issue edit <n> --add-assignee @me` 认领,已有 assignee 的不抢,未合并就放弃时撤掉;PR 描述写 `Closes #<n>`,合并自动关闭;先后关系用 `gh issue create --blocked-by <n>` 或 `gh issue edit --add-blocked-by <n>`;`#N` 先 `gh issue view`,失败再 `gh pr view`(编号共享)。

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.