Repository navigation
docs: add AGENTS.md to orient AI coding agents - #622
Merged
Merged
Conversation
Documents the hybrid Java/Go layout, the localhost/Intra module path, gomobile binding constraints, build and test commands, and the project conventions that are otherwise only discoverable by reading the code.
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.
What
Adds an
AGENTS.mdat the repository root describing the project for AI codingagents (and, incidentally, for new human contributors).
Why
Intra is a hybrid Java + Go project with a few conventions that are easy to get
wrong and are only discoverable by reading the code and the Gradle build:
localhost/Intraand lives at the repo root, while theGo sources are under
Android/app/src/go/. Imports look likelocalhost/Intra/Android/app/src/go/doh, which looks like a mistake but isn't.backend,intra,intra/splitandintra/protectare passed togomobile bind(goSourcePackagesinAndroid/app/build.gradle), andanything exported from
backendmust respect gomobile's type restrictions(hence workarounds like the comma-separated
ipsStrinNewDoHServer).protect.MakeDialer/protect.MakeListenConfig, or traffic loops back intothe VPN.
debug.SetGCPercent(10)inbackend/init.gois deliberate.loggingpackage, notlog/fmt.Contents
GoVpnAdapter->backend.ConnectSession->
intra.Tunnelflowstrict dependency locking, localization, license headers)
Documentation only; no code changes.