Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,10 @@ duplicating work that is already in flight.
extensive review. We are not trying to be discouraging, but we need to make
sure that we are focused on the most important work.

If you are building something that runs *on* Substrate rather than changing
Substrate itself, see [Integration
Repositories](docs/integration-repos.md) for where that code should live.

### Sizing PRs for review

We optimize PRs for easy review — large PRs get broken
Expand Down
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -194,6 +194,7 @@ We provide several sample applications demonstrating Agent Substrate's capabilit
* [API Configuration Guide](docs/api-guide.md): Detailed reference for configuring WorkerPools, ActorTemplates, Secrets, and Volumes.
* [Full CLI Documentation](cmd/kubectl-ate/README.md): Installation and usage for `kubectl-ate`.
* [Glossary](docs/glossary.md): Core terms (Actor, Atespace, ActorTemplate, WorkerPool, Worker, ate-api-server, atenet, atelet, ateom) and how they relate.
* [Integration Repositories](docs/integration-repos.md): Where integrations live, how their repositories are named, and how fixes flow back to core.
* [Observability Guide](docs/observability.md): Guide to actor logging, metrics, and distributed tracing.
* [Request Parking](docs/request-parking.md): How the router parks requests through transient worker-pool saturation.
* [Threat Model](docs/threat-model.md): Trust boundaries, assumptions, and known risks.
Expand Down
114 changes: 114 additions & 0 deletions docs/integration-repos.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,114 @@
# Integration Repositories: Structure and Naming

## Summary

Substrate is acquiring its first end-to-end integrations — workloads that *run
on* Substrate rather than demonstrate it. This document records where that code
lives, how the repositories are named, and how fixes flow back into core.

In short: trivial demos stay in the core repository, each non-trivial
integration gets one dedicated repository under the `agent-substrate`
organization, and gaps in core are closed by making core configurable rather
than by patching it downstream.

## Motivation

Until now every in-repo example has been small enough to live beside the code it
exercises. The first real integrations are not: they carry their own container
images, dependencies, release cadence, and potentially their own maintainers.

Without a written convention, whichever repository happens to be created first
sets the precedent for everything after it. This document makes the convention
explicit instead, so that the choice is deliberate.

## Where code lives

**Stays in the core repository.** Trivial demos and keyless API exercisers — the
counter demo, and the lifecycle mocks that CI uses to drive create, resume, and
suspend. The test is roughly: no API keys, no external services, no third-party
accounts required to run it.

**Gets its own repository under `agent-substrate`.** Non-trivial, end-to-end
integrations, including their code, container images, manifests, and SDKs. One
repository per integration. These are too large to carry in core, and a
dedicated repository lets them have their own maintainers without granting
access to core.

**Not a second organization.** GitHub supports only one level of organization
parentage, so a nested org is not actually available; a sibling org would add
onboarding and access-management overhead that a small number of peer
repositories under `agent-substrate` does not.

| Thing | Where it goes |
|---|---|
| Counter demo, keyless lifecycle mocks used by CI | Core repository |
| Non-trivial end-to-end integration (code, images, manifests, SDKs) | `agent-substrate/<name>` |
| A fix or new knob in Substrate that an integration needs | PR to the core repository |

## Naming

Two cases, depending on what the repository actually is:

**Capability-named**, when it provides a general Substrate capability that
happens to have one implementation today. Prefer `code-execution-sandbox` over
`sandbox` (too broad) or a vendor's product name (too narrow).

**Integration-named**, when it integrates one specific third-party product. Name
it for the product, not the vendor behind it — `hermes`, not the name of the
organization that publishes Hermes.

Avoid:

- **Generic names** such as `sandbox` or `plugins`, which claim far more ground
than any one repository covers.
- **Names that clone a vendor's API or brand**, which quietly commits the

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is slightly at odds with the integration bit below, should we limit them to OSS projects or something?

I don't think we have to fully resolve that now, but ... bit tricky

project to chasing someone else's naming decisions.
- **The `-integration` suffix.** Every repository in this category is an
integration, so the suffix carries no information: `hermes`, not
`hermes-integration`.

Third-party names may be used descriptively. When one is, the repository README
should note that the project is not affiliated with the third party and that
trademarks belong to their respective owners. Clear brand and policy edge cases
before the repository is created, not after.

## Upstreaming: prefer configurability over forks

Real integrations surface real gaps in core. Building a long-running agent on
Substrate turned up the need for configurable timeouts and golden-snapshot
warmup ([#487](https://github.com/agent-substrate/substrate/pull/487)), and ran
into suspend-safe actor networking
([#465](https://github.com/agent-substrate/substrate/issues/465)).

The path for those fixes should be short and well-travelled. An integration

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think integration repositories that we host should exist with any required patches to core, we should always land the patch to core first.

I think it's OK for independent POCs, but for official projects it's embarassing to depend on changes that don't exist in our own upstream yet. Let's just avoid that entirely. We are our own upstream if we're hosting both repos.

I'd drop this section or require no forking of core.

repository that accumulates local patches against core behavior will bitrot, and
the gap it works around stays invisible to everyone else.

The corollary is a design preference for core: when core behavior blocks an
integration, prefer making that behavior **configurable with defaults
unchanged** over forking it, vendoring it, or special-casing the caller.

## Worked examples

These two validate the convention rather than merely following it:

- **`agent-substrate/code-execution-sandbox`** — capability-named. A sandboxed
code-execution service built on Substrate, in the spirit of existing
code-execution products but not modeled on any one of their APIs.

- **`agent-substrate/always-on-agent`** — a connection-holding agent: a
multi-tenant gateway plus a suspendable per-conversation actor. Its first
implementation is built on a third-party agent runtime, and the repository is
capability-named rather than vendor-named while that name goes through the
brand check described above. It is the third-party-name edge case in practice.

## Not settled yet

These are open questions for the maintainers, deliberately left out of scope
here so they do not block the first repositories:

- **Governance tiers.** Whether to distinguish "official" from "community"

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IMHO: let community host their own outside the org. It's confusing to have things that are under our brand but not considered official. Let's just not do that.

integrations with different review bars, as Home Assistant and Obsidian do.
Likely worth revisiting once there are more than a handful of integrations.
- **Repository creation and access.** Who creates integration repositories, and
who grants per-integration maintainer access.
Loading