agentleFS
sparkler233sparkler233/project-consistency-kit/.agents/skills/catchup/SKILL.md

catchup

Skill1 starsChanged 43 days agoMITView on GitHub

Restore the project's overall context and current working state from its entry documents and Git without modifying the repository. Use when starting a session, catching up, or recovering project context before continuing work.

26 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use explain, ship and 4 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.
  • sunnyclinches44Skill

    explain

    Explains code using real-world analogies and ASCII diagrams

    Also in 3 projects that use this

  • AWSSkill

    ship

    Finalize dev work on an issue branch — update docs, push, and open a PR.

    Also in 4 projects that use this

  • BlockSkill

    plan

    Draft a TDD, PRD, or lightweight plan in the conversation without committing it.

    Also in 3 projects that use this

  • MicrosoftSkill

    pr-review

    Verify the technical accuracy of a vscode-docs pull request against the VS Code source code in microsoft/vscode. Use when reviewing a docs PR for factual correctness: setting names, command IDs, default values, API shapes, keybindings, versioned availability, and described behavior.

    Also in 3 projects that use this

  • MicrosoftSkill

    handoff

    Compact the current conversation into a handoff document for another agent to pick up.

    Also in 4 projects that use this

  • GoogleSkill

    tdd

    Test-driven development. Use when the user wants to build features or fix bugs test-first, mentions "red-green-refactor", or wants integration tests.

    Also in 4 projects that use this

The file

Files
SKILL.md
<!-- 一致性机制 version: 2026-10-03 -->

理解项目整体与当前工作现场,让用户能够判断你已接上项目、可以开始工作。全程只读:不改文件、不修入口、不运行测试或实验、不操作提交或 synced。

1. 理解整体

完整读取 PROJECT.md 与 一致性机制/运行规则.md。宿主已加载的规则不重读,没加载的必要规则自己读。了解项目的目的、当前阶段、基本要求与资料入口,不逐项展开各部分设计或待办,也不自选任务。

整体背景有关键缺口时,补读能解释它的原文;入口缺失时可用 README 等恢复能确定的部分。不要递归展开背景链接或核验全项目。具体任务的资料调查属于后续工作,不规定为恢复步骤。

本机制把当前说明留在项目文件,决策全文与形成过程保存在 Git 提交正文。需要追查时,可以沿 PROJECT 的指针,或用 git log --grep='^Decision: N$' 定位后读提交正文;提交标题只是线索,不是当前事实,也不必每次启动都检索历史。

2. 看工作现场

运行一个脚本取得 Git 概况:

node .agents/skills/wrapup/scripts/scope.mjs --overview --host <codex|claude|unknown>

按当前宿主选择 codex 或 claude,无法确定或不支持时用 unknown,不要从仓库里存在谁的配置来猜。startup_check 只检查必要文件与当前宿主的项目级接线;正常不逐项汇报,issues 是已发现的问题,unchecked 是未检查的范围,由你结合工作说明影响。自定义命令和 TOML 内联接线未完整检查,结果不证明 hook 已获宿主信任或实际运行;不自动修复,也不运行完整自检。

直接使用脚本给出的分支与基线,不另算或猜替代值。了解自上次收尾以来的变化、未保存工作和其他分支概况;未提交、未跟踪内容与目录树只看脚本列出的名称、数量和大小,不展开读取。改动存在不证明属于当前任务。

在任务分支上,从 current_branch_state.task 了解目标、进度与还剩;缺失时说明接手信息不完整。主线与本分支有交集、冲突或命中联动规则时,保留这一提醒;需要查清影响才能继续的,留到后续工作处理,不在恢复时同步或合并。

基线不可靠或概览无法运行时,不猜范围;恢复其余能确定的背景,说明限制。can_advance=false 本身不妨碍读取。已知的规则冲突、其他分支异常和 hook_failures 按实际影响说明;有 hook 失败记录时建议使用现有自检,不在 catchup 内执行。没有失败记录不等于已验证 hook 正常。

3. 简明反馈与工作引导

用简明易懂的表达,让用户看得出你理解项目及当前阶段,并知道接手需要留意的情况。按实际情况组织,不固定报告格式,不逐项罗列提交、决策和分支清单。影响接手的异常与不确定性应说明;文档记载不说成已经核验,未读到的内容不推断为无问题。

普通启动不例行介绍并行或要求选择模式。有其他 Session 工作时,说明加入需要注意的现场情况;用户表达并行需求时,可以用“并行模式”等易懂说法说明用途与实际启用方式。具体任务是否适合并行,在开展任务时判断和建议,由用户决定。说明下一步时,分清 Agent 能准备什么、用户只需在宿主做什么。获准启用后,分支与隔离工作区由 Agent 按已有机制准备,不把 Git 操作交给用户;需要用户打开新会话时给出简短指引,不承诺当前不支持的自动开会话或切换。catchup 本身不创建 Session、分支或 worktree。

理解整体与工作现场后即结束恢复。只调用 catchup 时,反馈后结束;同时授权后续任务且没有阻塞时,简要反馈后直接继续。关键缺口未解时,不做依赖它的动作。

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.