agentleFS
apacheapache/streampipes/streampipes-extensions/AGENTS.md

streampipes / streampipes-extensions

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

Applies to streampipes-extensions/ and all submodules. Root AGENTS.md applies as well. - Parent for adapters (streampipes-connect-adapters, streampipes-connectors-), processors (streampipes-processors-), sinks (streampipes-sinks-) and the runnable bundles (streampipes-extensions-all-jvm, streampipes-extensions-all-iiot, streampipes-extensions-iiot-minimal). - The parent pom uses streampipes-maven-plugin; do not change plugin behaviour unless the task requires it. 1. Implement the element in the fitting submodule (or a new one following the naming above). Processors and sinks implement the IStreamPipesPipelineElement family from streampipes-extensions-api; adapters extend StreamPipesAdapter. 2. Register it in the submodule's ExtensionModuleExport (implements…

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

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

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈1

    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:

    Add the element's resources under src/main/resources/<element app id>/: documentation.md, documentation.de.md, icon.png, strings.en, …

    line 25
  2. Very specific:

    If you bump an element's model version, ship the matching IModelMigrator in migrators() and a test for it.

    line 32
  3. Distinctive:

    Keep changes scoped to the affected submodule.

    line 38

≈ “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 (Extensions Aggregator)

Scope

Applies to streampipes-extensions/ and all submodules. Root AGENTS.md applies as well.

Module intent

  • Parent for adapters (streampipes-connect-adapters*, streampipes-connectors-*), processors (streampipes-processors-*), sinks (streampipes-sinks-*) and the runnable bundles (streampipes-extensions-all-jvm, streampipes-extensions-all-iiot, streampipes-extensions-iiot-minimal).
  • The parent pom uses streampipes-maven-plugin; do not change plugin behaviour unless the task requires it.

Recipe: add a processor, sink or adapter

  1. Implement the element in the fitting submodule (or a new one following the naming above). Processors and sinks implement the IStreamPipesPipelineElement family from streampipes-extensions-api; adapters extend StreamPipesAdapter.
  2. Register it in the submodule's *ExtensionModuleExport (implements IExtensionModuleExport): pipelineElements() for processors and sinks, adapters() for adapters, migrators() for model migrators. Example: streampipes-processors-filters-jvm/.../FilterExtensionModuleExport.java.
  3. Add the element's resources under src/main/resources/<element app id>/: documentation.md, documentation.de.md, icon.png, strings.en, strings.de. These are shipped to users and rendered in the UI; keep them in sync with the element's parameters.
  4. A new module must also be registered in each bundle it belongs to, for example streampipes-extensions-all-jvm/.../AllExtensionsInit.provideServiceDefinition() (registerModules(...)). A new element inside an existing module needs no bundle change.
  5. If you bump an element's model version, ship the matching IModelMigrator in migrators() and a test for it.
  6. Validate with mvn -pl streampipes-extensions/<submodule> -am test.

Rules

  • Keep changes scoped to the affected submodule; no multi-extension sweeps unless asked.
  • Preserve existing element resources when changing an element.
  • Preserve bundle startup and packaging behaviour in the streampipes-extensions-all-* modules.

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.