agentleFS
Sign inStart free
ElasticKnown publisherelastic/github-actions/AGENTS.md

github-actions

AGENTS.md6 starsChanged 7 months agoApache-2.0View on GitHub

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

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

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈3

    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. Very specific:

    ALWAYS use the repo-pinned toolchain versions for Node.js and pnpm.

    line 5
  2. Very specific:

    When changing a action or the build/test setup, ALWAYS run the checks from the repo root: pnpm checks.

    line 14
  3. Distinctive:

    All checks MUST pass before any changes are considered complete.

    line 15
  4. Distinctive:

    Update docs and tests when behavior or usage changes.

    line 22
  5. Distinctive:

    Never remove, skip, or comment out tests to make them pass.

    line 23

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

elastic/github-actions

Setup - CRITICAL

  • ALWAYS use the repo-pinned toolchain versions for Node.js and pnpm. ALWAYS verify the root package.json for the required engines and packageManager.

Overview

  • elastic/github-actions is intended for the organization's internal GitHub Actions.
  • Workflows are defined at the repo root in their own directories.

Validation

  • When changing a action or the build/test setup, ALWAYS run the checks from the repo root: pnpm checks.
  • All checks MUST pass before any changes are considered complete.

Contribution Hygiene

  • Unsure: read more code; if still stuck, ask w/ short options. Never guess.
  • Fix root cause (not band-aid).
  • Make focused changes; avoid unrelated refactors.
  • Update docs and tests when behavior or usage changes.
  • Never remove, skip, or comment out tests to make them pass; fix the underlying code.

Download now (ZIP)

  • 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 28,693 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.

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