agentleFS
Sign inStart free
apacheapache/skywalking-banyandb/AGENTS.md

skywalking-banyandb

AGENTS.md355 starsChanged 4 months agoApache-2.0View on GitHub

BanyanDB is a distributed time-series database written in Go. Follow nearby code and tests; keep changes focused on the requested behavior. - Finish the requested change and relevant verification without asking about routine next steps. Stop when the requested outcome is verified or a concrete blocker requires user input; do not expand into unrelated fixes or redesigns. - Preserve unrelated working-tree changes. Do not commit, push, publish, or change external resources unless requested or already authorized. - Use independent subagents…

  • 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

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:

    Use independent subagents when their work saves time.

    line 13
  2. Distinctive:

    Import groups: standard library, third-party packages, then this repository.

    line 21
  3. Very specific:

    Avoid shadowing existing variables.

    line 22
  4. Very specific:

    Check errors and add meaningful context with %w when wrapping.

    line 24
  5. Distinctive:

    Document exported functions and types with concise, punctuated comments.

    line 26
  6. Distinctive:

    Follow existing test conventions and run the smallest relevant suites first.

    line 31
  7. Distinctive:

    Read design documents only for the subsystem or contract being changed.

    line 38

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

BanyanDB Agent Guide

BanyanDB is a distributed time-series database written in Go. Follow nearby code and tests; keep changes focused on the requested behavior.

Completion and scope

  • Finish the requested change and relevant verification without asking about routine next steps. Stop when the requested outcome is verified or a concrete blocker requires user input; do not expand into unrelated fixes or redesigns.
  • Preserve unrelated working-tree changes. Do not commit, push, publish, or change external resources unless requested or already authorized.
  • Use independent subagents when their work saves time; small tasks do not need delegation or a separate review workflow.

Go conventions

  • .golangci.yml is authoritative for lint rules, protobuf import aliases, exclusions, and the 170-character line limit. .golangci-format.yml controls formatting with gci and gofumpt; its exclusions are not general lint exclusions.
  • Import groups: standard library, third-party packages, then this repository.
  • Avoid shadowing existing variables. Short names and if err := ... are valid when they do not shadow another variable; use descriptive names where useful.
  • Check errors and add meaningful context with %w when wrapping. Preserve error identity and the relevant API's error-handling conventions.
  • Document exported functions and types with concise, punctuated comments. Add implementation comments only for non-obvious logic.

Correctness and validation

  • Follow existing test conventions and run the smallest relevant suites first. Expand validation for affected integration boundaries, generated code, or shared infrastructure; avoid unrelated full builds during read-only or wording tasks.
  • Preserve persisted-data and wire compatibility. For format, schema, or protocol changes, check existing data and mixed-version behavior as applicable.
  • For concurrent or stateful changes, consider cancellation, resource ownership, bounded memory, and recovery. Use the repository's established helpers.
  • Read design documents only for the subsystem or contract being changed. Follow any more-specific AGENTS.md in the affected directory.

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