agentleFS
tethertotetherto/qvac/.github/AGENTS.md

qvac

AGENTS.md697 starsChanged 18 days agoApache-2.0View on GitHub

Use the active workflows, actions, and validation scripts as the source of truth. Do not duplicate current matrices, runner labels, workflow counts, action versions, or required-check configuration in agent instructions. Read the relevant references before changing CI: - ../docs/ci/LABELS.md for labels and fork trust. - ../docs/ci/MERGE-GUARD.md for required-check wiring. - ../docs/ci/SELF-HOSTED-RUNNERS.md for persistent runners and workspace cleanup. - ../docs/ci/TEAMS.md for approval ownership. - ../docs/ci/MOBILE-ON-DEMAND.md for dispatching addon mobile (Device Farm) tests and choosing the prebuild source. - ../docs/agent-automation.md for automation…

We split this AGENTS.md into the rules it gives an agent

7 rules. About 1 is common, 6 are distinctive, and 0 are very specific to this project.

  • ≈1

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈6

    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:

    Use the active workflows, actions, and validation scripts as the source of truth.

    line 3
  2. Distinctive:

    Do not duplicate current matrices, runner labels, workflow counts, action versions, or required-check configuration in agent instructions.

    line 4
  3. Distinctive:

    Read the relevant references before changing CI:

    line 7
  4. Distinctive:

    When editing workflows or composite actions:

    line 18
  5. Common:

    Treat fork-controlled code and metadata as untrusted, and never expose secrets to untrusted pull-request execution.

    line 22
  6. Distinctive:

    Follow the documented cleanup pattern for persistent self-hosted runners.

    line 27
  7. Distinctive:

    Run the narrowest relevant workflow linter and script tests before handoff.

    line 28

≈ “Common” is an estimate: at least 1 in 5 of the 36,368 AGENTS.md 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
AGENTS.md

GitHub and CI guidance

Use the active workflows, actions, and validation scripts as the source of truth. Do not duplicate current matrices, runner labels, workflow counts, action versions, or required-check configuration in agent instructions.

Read the relevant references before changing CI:

  • ../docs/ci/LABELS.md for labels and fork trust.
  • ../docs/ci/MERGE-GUARD.md for required-check wiring.
  • ../docs/ci/SELF-HOSTED-RUNNERS.md for persistent runners and workspace cleanup.
  • ../docs/ci/TEAMS.md for approval ownership.
  • ../docs/ci/MOBILE-ON-DEMAND.md for dispatching addon mobile (Device Farm) tests and choosing the prebuild source.
  • ../docs/agent-automation.md for automation safety.

When editing workflows or composite actions:

  • Pin third-party actions to full commit SHAs and retain a readable version comment.
  • Declare the least permissions needed. Prefer OIDC to long-lived credentials.
  • Treat fork-controlled code and metadata as untrusted, and never expose secrets to untrusted pull-request execution.
  • Quote shell inputs and pass untrusted values through environment variables rather than interpolating them into scripts.
  • Preserve the repository's merge-guard architecture when adding a gating job.
  • Follow the documented cleanup pattern for persistent self-hosted runners.
  • Run the narrowest relevant workflow linter and script tests before handoff.

Rewrite CI documentation in place when behavior changes. Do not append corrective notes that leave obsolete instructions active.

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.