agentleFS
QVerisAIQVerisAI/QVerisBot/scripts/AGENTS.md

QVerisBot / scripts

AGENTS.md184 starsChanged 7 months agoMITView on GitHub

This directory owns local tooling, script wrappers, and generated-artifact helper rules.

We split this AGENTS.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:

    Prefer existing wrappers over raw tool entrypoints when the repo already has a curated seam.

    line 7
  2. Distinctive:

    Do not bypass that lock for real heavy commands just to make a local loop look faster.

    line 14
  3. Very specific:

    If you change the lock heuristics, add or update the narrow tests under test/scripts/.

    line 16
  4. Distinctive:

    If a script writes generated artifacts, keep the source-of-truth generator, the package script, and the matching verification/check command …

    line 20
  5. Very specific:

    Prefer additive generator/check pairs like *:gen and *:check over one-off undocumented scripts.

    line 21
  6. Distinctive:

    Keep script-runner behavior, wrapper expectations, and generated-artifact guidance here.

    line 25
  7. Distinctive:

    Leave repo-global verification policy in the root AGENTS.md.

    line 26

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

Scripts Guide

This directory owns local tooling, script wrappers, and generated-artifact helper rules.

Wrapper Rules

  • Prefer existing wrappers over raw tool entrypoints when the repo already has a curated seam.
  • For tests, prefer scripts/run-vitest.mjs or the root pnpm test ... entrypoints over raw vitest run calls.
  • For lint/typecheck flows, prefer scripts/run-oxlint.mjs and scripts/run-tsgo.mjs when adding or editing package scripts or CI steps that should honor repo-local runtime behavior.

Local Heavy-Check Lock

  • Respect the local heavy-check lock behavior in scripts/lib/local-heavy-check-runtime.mjs.
  • Do not bypass that lock for real heavy commands just to make a local loop look faster.
  • Metadata-only or explicitly narrow commands may skip the lock when the existing helper logic says that is safe.
  • If you change the lock heuristics, add or update the narrow tests under test/scripts/.

Generated Outputs

  • If a script writes generated artifacts, keep the source-of-truth generator, the package script, and the matching verification/check command aligned.
  • Prefer additive generator/check pairs like *:gen and *:check over one-off undocumented scripts.

Scope

  • Keep script-runner behavior, wrapper expectations, and generated-artifact guidance here.
  • Leave repo-global verification policy in the root AGENTS.md.

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.