agentleFS
Sign inStart free
liush2yuxjtuliush2yuxjtu/html-artifacts/AGENTS.md

html-artifacts

AGENTS.md2 starsChanged 52 days agoApache-2.0View on GitHub

Use /verify skill every time BEFORE we make a PR git never installs hooks on clone or pull: a cloned repository must not be able to run code on your machine. This repo keeps its hooks versioned in .githooks/, and each clone opts in once. - Check: sh chatcut-v3/scripts/check-hooks.sh prints nothing when core.hooksPath=.githooks, otherwise the fix. Claude Code runs it at session start (.claude/settings.json → SessionStart) and passes any warning into the session context. - Install: sh chatcut-v3/scripts/install-hooks.sh. It is…

  • Commits and pushes
  • Where files are headingNew AGENTS.md files have more rules about keeping secrets out of the code, and fewer about code style.

    Of the AGENTS.md files we read, the 31,774 first seen in the last six months, against the older ones: the kind of rule that gained most share, and the kind that lost most. About files like this in general, not this one, and an estimate, since a kind is a pattern in the words.

  • In this repository6 other files it gives its agents.

The file

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

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

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈2

    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
  • could be automatic: a setting could enforce it
  1. Distinctive:

    Use /verify skill every time BEFORE we make a PR

    line 4
  2. Very specific:

    Run relevant existing tests locally through /verify before PR creation.

    line 7
  3. Distinctive:

    Keep test files in the repository.

    line 8
  4. Very specific:

    Do not open a PR on FAIL or BLOCKED.

    line 10

≈ “Common” is an estimate: at least 1 in 5 of the 40,246 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
<!-- verify-shift-left:start -->

Pre-PR verification

Use /verify skill every time BEFORE we make a PR

  • Canonical skill source: liush2yuxjtu/claude-runtime-verification-skills@0d585c02bbeaa756e45865dd0a36f84d1b08f589.
  • Run relevant existing tests locally through /verify before PR creation.
  • Keep test files in the repository; shift their execution left instead of deleting coverage.
  • Preserve remote CI only for checks that genuinely require remote, production, deployment, secret, runner, or environment-specific execution.
  • Do not open a PR on FAIL or BLOCKED. SKIP is only valid when the skill says no executable runtime behavior applies.
<!-- verify-shift-left:end --><!-- local-git-hooks:start -->

Local git hooks (soft gate)

git never installs hooks on clone or pull: a cloned repository must not be able to run code on your machine. This repo keeps its hooks versioned in .githooks/, and each clone opts in once.

  • Check: sh chatcut-v3/scripts/check-hooks.sh prints nothing when core.hooksPath=.githooks, otherwise the fix. Claude Code runs it at session start (.claude/settings.json → SessionStart) and passes any warning into the session context.
  • Install: sh chatcut-v3/scripts/install-hooks.sh. It is local and reversible (git config --unset core.hooksPath). An agent that sees the warning may install it and must tell the human it did.
  • Never override a different existing core.hooksPath: the installer refuses, and the agent asks the human how to chain .githooks/post-merge into their own hook.
  • What it does: after any git pull/git merge that changes chatcut-v3/, .githooks/post-merge rebuilds the playable and serves http://127.0.0.1:8777/compare.html (frozen original vs our playable). Stop the server with sh chatcut-v3/scripts/preview.sh stop. Before any git push, .githooks/pre-push runs sh scripts/test-fast.sh (offline contract tests, about 1s) and blocks the push if one fails; git push --no-verify skips it knowingly.
  • Soft gate: a missing hook never blocks work or a PR. /verify step 0 records its state in the report.
<!-- local-git-hooks: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.

Check your setup, free