agentleFS
Sign inStart free
AgentsKit-ioAgentsKit-io/agentskit/.github/copilot-instructions.md

agentskit

Copilot instructions38 starsChanged 7 months agoMITView on GitHub

Read AGENTS.md at the repository root before suggesting code. It is the single source of truth for all AI agents working on AgentsKit. For the full rule set, package map, commands, workflow expectations, and anti-patterns, see AGENTS.md.

We split this copilot-instructions.md into the rules it gives an agent

3 rules. About 0 are common, 0 are distinctive, and 3 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈0

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 3

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  • could be automatic: a setting could enforce it
  1. Very specific:

    Read AGENTS.md at the repository root before suggesting code.

    line 3
  2. Very specific:

    Every user-facing change needs a changeset (pnpm changeset).

    line 10
  3. Very specific:

    Never bypass CI with --no-verify or skip flags.

    line 11

≈ “Common” is an estimate: at least 1 in 5 of the 3,669 Copilot instructions files we read have a rule of the same kind, not the same words. “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
copilot-instructions.md

GitHub Copilot instructions

Read AGENTS.md at the repository root before suggesting code. It is the single source of truth for all AI agents working on AgentsKit.

Summary of highest-priority rules

  • @agentskit/core has zero runtime dependencies and must stay under 10 KB gzipped. Do not add imports that pull new packages into core.
  • Core contracts (Adapter, Tool, Memory, Retriever, Skill, Runtime) are pinned to ADRs under docs/architecture/adrs/. Do not change them without a new ADR.
  • TypeScript strict mode, named exports only, no any, no default exports, no hardcoded styles (use data-ak-*).
  • Every user-facing change needs a changeset (pnpm changeset).
  • Never bypass CI with --no-verify or skip flags. Never force-push to main.

For the full rule set, package map, commands, workflow expectations, and anti-patterns, see AGENTS.md.

Download now (ZIP)

  • Where files are headingNew Copilot instructions files have more rules about branches and pull requests, and fewer about code style.

    Of the Copilot instructions files we read, the 2,297 first seen in the last six months, against the older ones: the kind of rule that gained most share, and the kind that lost most. About files like this in general, not this one, and an estimate, since a kind is a pattern in the words.

  • In this repository5 other files it gives its agents.

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.

Check your setup, free