agentleFS
RichardGeorgeDavisRichardGeorgeDavis/Codex-Workspace/.agents/skills/repo-onboarding/SKILL.md

repo-onboarding

Skill2 starsChanged 56 days agoMITView on GitHub

Onboard a repo into Codex Workspace with runtime metadata, AGENTS guidance, and agent-tooling conventions

10 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use mcp-maintainer and release-guard.

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

    mcp-maintainer

    Operate and maintain the local MCP server for this repository. Use for MCP tool updates, policy-guard changes, host configuration, and MCP runtime troubleshooting.

    Also in 3 projects that use this

  • KhaiTrang1995Skill

    release-guard

    Run release-readiness checks for this repository. Use when validating docs, scripts, verification coverage, and operational safety before merge or release.

    Also in 3 projects that use this

The file

We split this skill into the rules it gives an agent

9 rules. 0 are common, 2 are distinctive, and 7 are very specific to this project.

  • 0

    Common

    Most of the 10 edited versions we read keep these.

  • 2

    Distinctive

    This author's own choices. Worth a look.

  • 7

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Very specific:

    Use this skill when adding a repo under repos/ or making an existing repo workspace-ready.

    line 8
  2. Very specific:

    Add or refine .workspace/project.json only if runtime behavior is not obvious.

    line 13
  3. Very specific:

    Ensure README.md exists. If it is missing, start from tools/templates/repo-docs/README.template.md.

    line 14
  4. Distinctive:

    Make sure the README explains setup, run, preview, and current repo purpose.

    line 15
  5. Very specific:

    Add a repo-local cover block that points to a PNG path such as docs/cover.png, using the placeholder template until a real capture exists.

    line 16
  6. Distinctive:

    Add repo-level AGENTS.md only when repo-specific rules are genuinely needed.

    line 17
  7. Very specific:

    If the repo needs Codex-visible capabilities, use .codex/skills/.

    line 18
  8. Very specific:

    Add .agents/skills/ only when the repo also benefits from a tracked compatibility mirror.

    line 19
  9. Very specific:

    If the repo needs broader multi-tool agent hints, use .workspace/agent-stack.json.

    line 20

“Common” is measured: kept by at least 6 in 10 of the 10 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Repo Onboarding

Use this skill when adding a repo under repos/ or making an existing repo workspace-ready.

Checklist

  1. Classify the repo conservatively from files first.
  2. Add or refine .workspace/project.json only if runtime behavior is not obvious.
  3. Ensure README.md exists. If it is missing, start from tools/templates/repo-docs/README.template.md.
  4. Make sure the README explains setup, run, preview, and current repo purpose.
  5. Add a repo-local cover block that points to a PNG path such as docs/cover.png, using the placeholder template until a real capture exists.
  6. Add repo-level AGENTS.md only when repo-specific rules are genuinely needed.
  7. If the repo needs Codex-visible capabilities, use .codex/skills/.
  8. Add .agents/skills/ only when the repo also benefits from a tracked compatibility mirror.
  9. If the repo needs broader multi-tool agent hints, use .workspace/agent-stack.json.

Helpful commands

tools/scripts/bootstrap-repo.sh
tools/scripts/init-agents-tree.sh repos/<repo>
tools/scripts/sync-codex-skills.sh repos/<repo>

Good defaults

  • Frontend-style repos default to direct.
  • WordPress repos usually stay external.
  • Agent tooling should be scaffolded as tracked files, not hidden state.

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.