docs: convention for integration repository structure and naming - #712
Open
Maya Wang (mayawang) wants to merge 1 commit into
Open
docs: convention for integration repository structure and naming#712Maya Wang (mayawang) wants to merge 1 commit into
Maya Wang (mayawang) wants to merge 1 commit into
Conversation
Records where end-to-end integrations live, how their repositories are named, and how fixes they need flow back into core. Trivial demos stay in the core repo; each non-trivial integration gets one dedicated repo under the agent-substrate org; core gaps are closed by making core configurable with defaults unchanged rather than by patching it downstream. Written down before the first integration repositories exist, so that precedent is chosen deliberately rather than inherited from whichever repo happens to be created first. Governance tiers and repository-creation access are called out as open questions rather than answered here.
Maya Wang (mayawang)
requested review from
Benjamin Elder (BenTheElder) and
Julian Gutierrez Oschmann (juli4n)
August 3, 2026 13:30
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds
docs/integration-repos.md: where end-to-end integrations live, how theirrepositories are named, and how the fixes they need flow back into core.
The convention in one line — trivial demos stay in the core repo, each
non-trivial integration gets one dedicated repo under the
agent-substrateorg, and core gaps get closed by making core configurable with defaults
unchanged rather than by patching it downstream.
Why now
We are about to create the first real, end-to-end integrations rather than
counter-style demos: a code-execution sandbox, and an always-on agent. Both are
large enough to need their own images, dependencies, and release cadence.
Whichever repository gets created first will set the precedent for every one
after it. This writes the convention down so that precedent is chosen
deliberately instead of inherited by accident.
What it covers
which side something falls on (API keys, external services, third-party
accounts), and why this is a set of peer repos rather than a second org.
(
code-execution-sandbox), integration-named for specific third-partyproducts, named for the product rather than the vendor behind it. Plus what to
avoid: over-broad names, names that clone a vendor's API or brand, and the
redundant
-integrationsuffix.the repo README, and brand/policy edge cases cleared before the repo exists.
accumulate local patches against core bitrot, and the gap they work around
stays invisible to everyone else. So: prefer making core behavior configurable
with defaults unchanged. feat: readyz: make the overall wait timeout configurable per template #487 and Suspend-safe actor networking via injected in-sandbox ingress/egress proxies #465 are linked as illustrations of that
pattern — this PR does not depend on either, and branches from
main.following it, including the third-party-name edge case.
Review
This was announced at the community meeting and circulated as a shared design
doc with a 7-day review window, which has now closed. It synthesizes the
#integrationsthread discussion. Comment history:https://docs.google.com/document/d/1Tb6u0b1XSvWrNpoyD4jdsQaJ58aAgDtQOM18uxujs-8/edit
This PR is the trimmed version: doc-review scaffolding — status block, reviewer
list, self-link — is dropped, and only the durable convention is carried over.
Left open
Two questions are deliberately out of scope, called out in the doc rather than
answered. Both are maintainer calls and neither blocks the first repositories:
integrations with different review bars, as Home Assistant and Obsidian do.
access.
Also in this PR
docs/.CONTRIBUTING.mdgets one sentence pointing there, since "where does myintegration go?" is a question a contributor asks before opening a PR.
Fixes #<issue_number_goes_here>