agentleFS
GitHubKnown publishergithub/squad/packages/squad-sdk/templates/copilot-instructions.md

squad / templates

Copilot instructions3.4k starsChanged 2 months agoMITView on GitHub

You are working on a project that uses Squad, an AI team framework. When picking up issues autonomously, follow these guidelines. IMPORTANT — run this check on EVERY session start, before doing any work: Inspect your agent_instructions for the coordinator canaries. This is a two-state payload-integrity check within a known Squad coordinator session; it verifies whether the coordinator payload loaded fully or was visibly truncated. It is not proof that an agent with no canaries is safely non-Squad — wholly…

1 other project uses a version of this.

Adopted by

Most recently taken up by

The file

Show its rules and text

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

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

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈3

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 12

    Very specific

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

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

    If the HEAD canary SQUAD_COORDINATOR_CANARY_HEAD_b7d2 is absent, the Squad coordinator payload is not observable from inside this prompt.

    line 12
  2. Very specific:

    If the HEAD canary SQUAD_COORDINATOR_CANARY_HEAD_b7d2 is present and the EOF canary SQUAD_COORDINATOR_CANARY_a8f3 is present, the …

    line 13
  3. Very specific:

    If the HEAD canary SQUAD_COORDINATOR_CANARY_HEAD_b7d2 is present but the EOF canary SQUAD_COORDINATOR_CANARY_a8f3 is absent, the …

    line 14
  4. Very specific:

    Do not continue with normal Squad routing, spawning, PR, or branch-protection behavior after emitting the warning.

    line 22
  5. Distinctive:

    Before starting work on any issue:

    line 26
  6. Very specific:

    Read .squad/team.md for the team roster, member roles, and your capability profile.

    line 28
  7. Very specific:

    Read .squad/routing.md for work routing rules.

    line 29
  8. Very specific:

    If the issue has a squad:{member} label, read that member's charter at .squad/agents/{member}/charter.md to understand their domain …

    line 30
  9. Very specific:

    Before starting work, check your capability profile in .squad/team.md under the Coding Agent → Capabilities section.

    line 34
  10. Very specific:

    Use the squad branch convention:

    line 45
  11. Distinctive:

    When opening a PR:

    line 53
  12. Very specific:

    If the issue had a squad:{member} label, mention the member: Working as {member} ({role})

    line 55
  13. Very specific:

    If this is a 🟡 needs-review task, add to the PR description: ⚠️ This task was flagged as "needs review" — please have a squad member …

    line 56
  14. Very specific:

    Follow any project conventions in .squad/decisions.md

    line 57
  15. Distinctive:

    If you make a decision that affects other team members, write it to:

    line 61

≈ “Common” is an estimate: at least 1 in 5 of the 3,779 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
<!-- squad:copilot-instructions:start -->

Copilot Coding Agent — Squad Instructions

You are working on a project that uses Squad, an AI team framework. When picking up issues autonomously, follow these guidelines.

Coordinator Canary Check

IMPORTANT — run this check on EVERY session start, before doing any work:

Inspect your agent_instructions for the coordinator canaries. This is a two-state payload-integrity check within a known Squad coordinator session; it verifies whether the coordinator payload loaded fully or was visibly truncated. It is not proof that an agent with no canaries is safely non-Squad — wholly absent payloads and proven non-Squad agents require a host-level identity beacon before custom-agent instruction ingestion.

  1. If the HEAD canary SQUAD_COORDINATOR_CANARY_HEAD_b7d2 is absent, the Squad coordinator payload is not observable from inside this prompt. Treat non-Squad discrimination as an OPEN host-level concern; do not claim this check proved the current agent is non-Squad.
  2. If the HEAD canary SQUAD_COORDINATOR_CANARY_HEAD_b7d2 is present and the EOF canary SQUAD_COORDINATOR_CANARY_a8f3 is present, the coordinator prompt loaded fully. Proceed with normal Squad behavior.
  3. If the HEAD canary SQUAD_COORDINATOR_CANARY_HEAD_b7d2 is present but the EOF canary SQUAD_COORDINATOR_CANARY_a8f3 is absent, the coordinator prompt loaded but was truncated before the end.

When the coordinator prompt is truncated, you MUST:

  1. STOP — do not proceed with standard Squad behavior.
  2. WARN the user with this exact message:
    ⚠️ Squad coordinator (squad.agent.md) loaded but appears to be truncated before the EOF canary. Do NOT proceed with standard Squad behavior — Squad's safety rails are incomplete. Please restart your session.
  3. Do not continue with normal Squad routing, spawning, PR, or branch-protection behavior after emitting the warning.

Team Context

Before starting work on any issue:

  1. Read .squad/team.md for the team roster, member roles, and your capability profile.
  2. Read .squad/routing.md for work routing rules.
  3. If the issue has a squad:{member} label, read that member's charter at .squad/agents/{member}/charter.md to understand their domain expertise and coding style — work in their voice.

Capability Self-Check

Before starting work, check your capability profile in .squad/team.md under the Coding Agent → Capabilities section.

  • 🟢 Good fit — proceed autonomously.
  • 🟡 Needs review — proceed, but note in the PR description that a squad member should review.
  • 🔴 Not suitable — do NOT start work. Instead, comment on the issue:
    🤖 This issue doesn't match my capability profile (reason: {why}). Suggesting reassignment to a squad member.

Branch Naming

Use the squad branch convention:

squad/{issue-number}-{kebab-case-slug}

Example: squad/42-fix-login-validation

PR Guidelines

When opening a PR:

  • Reference the issue: Closes #{issue-number}
  • If the issue had a squad:{member} label, mention the member: Working as {member} ({role})
  • If this is a 🟡 needs-review task, add to the PR description: ⚠️ This task was flagged as "needs review" — please have a squad member review before merging.
  • Follow any project conventions in .squad/decisions.md

Decisions

If you make a decision that affects other team members, write it to:

.squad/decisions/inbox/copilot-{brief-slug}.md

The Scribe will merge it into the shared decisions file.

<!-- squad:copilot-instructions:end -->

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.