agentleFS
Sign inStart free
apacheapache/streampipes/streampipes-client-go/AGENTS.md

streampipes / streampipes-client-go

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

Applies to streampipes-client-go/. Root AGENTS.md applies for repository-wide rules; the Java/Maven build commands there do not apply here. - Module github.com/apache/streampipes/streampipes-client-go (go 1.25 in go.mod); CI uses Go 1.25 (.github/workflows/go-client.yml). - CI runs, from this directory: - streampipes/ — the client package: streampipesclient.go, one *api.go per resource (pipelineapi.go, adapterapi.go, dataset_api.go, ...), model/, config/, internal/, utils/. - examples/ — runnable usage examples; keep them compiling when the API changes. - docs/ — Hugo documentation site; docs/content/en/docs/contribution-guidelines.md.

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

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

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈0

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

    Add a *_api.go file per new resource rather than growing streampipes_client.go.

    line 30
  2. Very specific:

    Every .go file carries the ASF license header (// comment block, see existing files).

    line 31
  3. Very specific:

    Add _test.go coverage for new API functions.

    line 32

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

AGENTS Guide (Go Client)

Scope

Applies to streampipes-client-go/. Root AGENTS.md applies for repository-wide rules; the Java/Maven build commands there do not apply here.

Toolchain and gates

  • Module github.com/apache/streampipes/streampipes-client-go (go 1.25 in go.mod); CI uses Go 1.25 (.github/workflows/go-client.yml).
  • CI runs, from this directory:
goimports -l .      # must print nothing — run goimports -w . before committing
go test ./...

Layout

  • streampipes/ — the client package: streampipes_client.go, one *_api.go per resource (pipeline_api.go, adapter_api.go, dataset_api.go, ...), model/, config/, internal/, utils/.
  • examples/ — runnable usage examples; keep them compiling when the API changes.
  • docs/ — Hugo documentation site; docs/content/en/docs/contribution-guidelines.md.

Conventions

  • Mirror the Java and Python clients' API surface and naming.
  • Add a *_api.go file per new resource rather than growing streampipes_client.go.
  • Every .go file carries the ASF license header (// comment block, see existing files).
  • Add _test.go coverage for new API functions; the suite is small, so each one counts.

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.

Reviews can't be read right now.

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