agentleFS
PostHogKnown publisherPostHog/duckgres/AGENTS.md

duckgres

AGENTS.md189 starsChanged 9 months agoMITView on GitHub

  • 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,542 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

8 rules. About 0 are common, 5 are distinctive, and 3 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.

  • 3

    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:

    Keep configs and flags explicit.

    line 5
  2. Distinctive:

    When following a plan file, mark tasks upon completion

    line 7
  3. Very specific:

    Always run just lint before committing.

    line 8
  4. Distinctive:

    Prefer correctness, maintainability, robustness over shortcut implementations.

    line 10
  5. Very specific:

    Use just recipes instead of raw commands (run just to see all recipes).

    line 13
  6. Distinctive:

    If a test exposes a platform bug, report the bug with exact failure details instead of fixing the test.

    line 21
  7. Distinctive:

    This repo is public: Never expose customer or internal data in anything that lands here — PR titles/bodies, commit messages, code, …

    line 24
  8. Very specific:

    When a diagnostic detail is needed for context, redact it (<org-id>, org A/org B, "the prod cluster") or keep it in the local conversation …

    line 26

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

AGENTS

Work Style

  • TDD with red-green cycle is required: write/adjust tests first and run them to confirm they fail (red), then implement the minimum code to make them pass (green).
  • Keep configs and flags explicit; document defaults in README.
  • Provide runbooks for local dev and failure recovery.
  • When following a plan file, mark tasks upon completion
  • Always run just lint before committing.
  • Parallelize using subagents when possible.
  • Prefer correctness, maintainability, robustness over shortcut implementations.

Command Runner

  • Use just recipes instead of raw commands (run just to see all recipes).
  • just ci runs the full local CI pipeline (lint + unit + integration + controlplane tests).
  • just lint runs golangci-lint (not go vet — CI uses golangci-lint).

Testing

  • Perftest query and coverage additions are exempt from the TDD requirement: do not add tests solely to test perftests. Only make minimal compatibility updates to existing tests when needed.
  • Tests should model realistic user behavior, not work around current service limitations.
  • If a test exposes a platform bug, report the bug with exact failure details instead of fixing the test.

Security / Data Handling

  • This repo is public. Never expose customer or internal data in anything that lands here — PR titles/bodies, commit messages, code, comments, or test fixtures.
  • This includes customer/org IDs and UUIDs, customer names, internal hostnames/cluster names/endpoints, secrets, and internal-only identifiers.
  • When a diagnostic detail is needed for context, redact it (<org-id>, org A/org B, "the prod cluster") or keep it in the local conversation only — not in the published artifact.

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.