agentleFS
Omni-CraftOmni-Craft/OmniCraft/.github/copilot-instructions.md

OmniCraft

Copilot instructions1 starsChanged 4 months agoApache-2.0View on GitHub

Every pull request that introduces a new feature must include at least one end-to-end (e2e) test covering the happy-path behaviour of that feature. - E2E tests live under tests/e2e/. - If a PR adds new user-facing functionality and does not add or update an e2e test, flag it as a required change. - Bug-fix or refactor PRs that do not change observable behaviour are exempt. A pull request that changes behaviour under omnicraft/ should add or update a test in…

The file

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

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

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈5

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 2

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Every pull request that introduces a new feature must include at least one end-to-end (e2e) test covering the happy-path behaviour of that …

    line 5
  2. Distinctive:

    If a PR adds new user-facing functionality and does not add or update an e2e test, flag it as a required change.

    line 9
  3. Very specific:

    Prefer a fast, focused unit test in the area suite — that is what most changes need.

    line 19
  4. Very specific:

    Do not ask for a test for pure refactors, renames, type-only changes, dependency bumps, comment/docstring/logging edits, or anything with …

    line 44
  5. Distinctive:

    When in doubt about whether a change needs a test, raise it as a question rather than a required change.

    line 48
  6. Distinctive:

    If a UI PR has an empty Demo section, flag it as a request for a screenshot or recording.

    line 63
  7. Distinctive:

    Do not ask for a test for styling/formatting-only changes, copy tweaks with no flow change, type-only changes, dependency bumps, or …

    line 65

≈ “Common” is an estimate: at least 1 in 5 of the 3,827 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

Copilot Code Review Instructions

E2E Test Requirement

Every pull request that introduces a new feature must include at least one end-to-end (e2e) test covering the happy-path behaviour of that feature.

  • E2E tests live under tests/e2e/.
  • If a PR adds new user-facing functionality and does not add or update an e2e test, flag it as a required change.
  • Bug-fix or refactor PRs that do not change observable behaviour are exempt.

Backend Test Coverage

A pull request that changes behaviour under omnicraft/ should add or update a test in the suite matching the area it touches. If a behaviour change ships without a covering test, flag it and name the suite the test belongs in.

Prefer a fast, focused unit test in the area suite — that is what most changes need. Only expect an integration or e2e test when the change genuinely spans components or full-stack flows; do not push for a heavier test where a unit test would suffice.

Most backend areas mirror their source directory under tests/:

Area changed (omnicraft/…)Expected test suite (tests/…)
server/server/
runner/runner/
runtime/runtime/
tools/tools/
inner/inner/
llms/llms/
db/db/ (flag schema migrations especially)
policies/policies/
repl/repl/
entities/entities/
stores/stores/
host/host/
spec/spec/
  • A test under tests/integration/ or tests/e2e/ that exercises the change also satisfies the requirement — don't insist on the exact area suite.
  • Do not ask for a test for pure refactors, renames, type-only changes, dependency bumps, comment/docstring/logging edits, or anything with no observable behaviour change.
  • A trivial, empty, or unrelated test does not count as coverage.
  • When in doubt about whether a change needs a test, raise it as a question rather than a required change.

Frontend Test Coverage

A pull request that changes behaviour under web/ should add or update a colocated Vitest unit test — a *.test.ts or *.test.tsx file beside the component or module it touches. If a behaviour change ships without one, flag it.

  • A change to user-facing UI behaviour additionally needs a Playwright test under tests/e2e_ui/. That requirement is already enforced by the E2E UI Required status check, so do not re-flag it here — focus the review on the colocated unit test.
  • A UI / frontend PR should also include a video or images in the Demo section of the PR description (with the "UI / frontend change" box checked). If a UI PR has an empty Demo section, flag it as a request for a screenshot or recording.
  • Do not ask for a test for styling/formatting-only changes, copy tweaks with no flow change, type-only changes, dependency bumps, or refactors with no observable behaviour change.
  • A trivial, empty, or unrelated test does not count as coverage.

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.