agentleFS
mikefarahmikefarah/yq/.github/copilot-instructions.md

yq

Copilot instructions16k starsChanged 11 months agoMITView on GitHub

yq has millions of users, many running it unattended in CI/CD pipelines. Existing behaviour must not change disruptively. Use UK English spelling. For every PR, check whether existing behaviour changes. Treat the following as potential breaking changes: If the PR description states the behaviour change is the purpose (for example fixing formatting), do not object to the change itself. Instead check that: the old behaviour is pinned by a characterisation test; changed expectations match only the stated intent, with no…

Trending

More talk lately.about the whole repository

Dec 2025: 0 mentionsJan 2026: 0 mentionsFeb 2026: 1 mentionMar 2026: 0 mentionsApr 2026: 0 mentionsMay 2026: 0 mentionsJun 2026: 3 mentionsJul 2026: 1 mentionAug 2026: 2 mentionsSep 2026: 17 mentionsOct 2026: 4 mentionsNov 2026: 2 mentions
Dec 2025Jun 2026Nov 2026
Mentions a month of the mikefarah/yq repository that our weekly crawl found. There is no adoption data for this file yet.

Who's talking about mikefarah/yq

The biggest 5 of 93 mentions linking to the repository that our crawl found. Each line is their own headline.

See all 93

Talked about on GitHub, Stack Overflow, YouTube, Bluesky, Hacker News and the web (93 times).

On GitHub · 40

35 more on GitHub

On Stack Overflow · 30

25 more on Stack Overflow

On YouTube · 10

5 more on YouTube

On Bluesky · 8

3 more on Bluesky

On the web · 1

The file

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

1 rule. About 0 are common, 1 is distinctive, and 0 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈1

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 0

    Very specific

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

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Coverage gaps: If behaviour changes but no existing test covers the old behaviour, say so and suggest adding characterisation tests that …

    line 19

≈ “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

yq review instructions

yq has millions of users, many running it unattended in CI/CD pipelines. Existing behaviour must not change disruptively. Use UK English spelling.

Backward-compatibility review (highest priority)

For every PR, check whether existing behaviour changes. Treat the following as potential breaking changes:

  • Output changes: formatting, whitespace, indentation, comments, quoting, key ordering, null/empty handling.
  • Changed stdout/stderr split, exit codes, or error message text.
  • Removed or renamed CLI flags, operators, formats, or env vars; changed flag defaults.
  • Changed operator semantics, or encoder/decoder behaviour (pkg/yqlib/encoder_*.go, decoder_*.go).
  • New behaviour that is on by default and should be opt-in (flag or preference).
  • Removal without a deprecation path (keep the old name working, warn on stderr, document, remove in a later major release).

Tests as a compatibility signal

  1. Modified expectations. Explicitly call out any PR that updates, loosens, skips or deletes an existing expectation: Go tests (pkg/yqlib/*_test.go, cmd/*_test.go), doc-driven examples (expected in expressionScenario/formatScenario, which generate pkg/yqlib/doc/**), or acceptance scripts (acceptance_tests/*.sh). Flag it as a potential breaking change and ask the author to justify it. Do not accept "the test was wrong" without evidence.
  2. Coverage gaps. If behaviour changes but no existing test covers the old behaviour, say so and suggest adding characterisation tests that pin the old behaviour (and the new opt-in behaviour) before the change.
  3. Bug fixes must include a new test that exposes the bug, alongside the fix itself.

Intentional behaviour changes

If the PR description states the behaviour change is the purpose (for example fixing formatting), do not object to the change itself. Instead check that: the old behaviour is pinned by a characterisation test; changed expectations match only the stated intent, with no unrelated drift; the change is opt-in, or the description explains user impact and a migration path; and a verdict is still given (usually Medium or High).

Required verdict

End the review with:

Compatibility risk: None / Low / Medium / High followed by concise reasoning listing the affected behaviours, who might be impacted (for example CI scripts parsing output), and any requested mitigations.

Also ensure generated docs under pkg/yqlib/doc/ are not hand-edited to hide a behaviour change.

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.