Repository navigation
docs: add repository structure and contributor guidelines - #250
Merged
Merged
Conversation
ZouR-Ma
force-pushed
the
docs/complete-module-agent-guidelines
branch
from
October 14, 2026 08:24
ec0519b to
8370fff
Compare
Document configuration migrations, host contracts, provider adapters, telemetry, and terminal rendering. Define dependency boundaries and module-specific validation commands.
Describe Agent Loop, session, context projection, and compaction ownership. Keep coding-agent guidance at package scope and document tools, extensions, orchestration, and Step integrations against the current implementation.
Define startup, mode routing, process lifecycle, and protocol output boundaries. Document host-to-runtime-to-view dependencies, input handling, redraws, and focused validation.
Connect module guidance through the repository architecture and ownership map. Add documentation, script, release, and plugin conventions while preserving the existing commit attribution policy and CLAUDE.md reference.
ZouR-Ma
force-pushed
the
docs/complete-module-agent-guidelines
branch
from
October 14, 2026 09:27
8370fff to
976a534
Compare
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.
Problem
The repository's agent instructions covered commit attribution but did not provide a shared map of module ownership, dependency boundaries, coding practices, or collaboration and validation expectations.
Changes
AGENTS.mdfiles covering the repository, packages, CLI host and UI, generic harness, documentation, scripts, release packaging, and plugins.CLAUDE.mdreference, and keep private release infrastructure outside the public repository.Behavior and compatibility
Repository coding agents receive directory-specific implementation and collaboration rules, and contributors receive consistent submission and review guidance. Product runtime behavior, product prompts, dependencies, and public package interfaces are unchanged.
Validation
pnpm run checkpassed on macOS with Node 24.3.0 and pnpm 9.15.9, including types, public-source boundaries, repository guards, and browser bundle smoke../test.shpassed with its isolated user-resource environment,TMPDIR=/private/tmp, and a local wrapper for the existing pnpm 9.15.9 cache. Coding-agent: 4,435 passed / 59 skipped; CLI: 677 passed; the other workspace suites and root script tests also passed. No real model requests were enabled.git diff --check 3ba89e0cbfe6be78cccdafb5aeafd2592177cbb8...HEADpassed.CLAUDE.mdwere preserved.a90bfa5: Linux / Node 22build-check-testandCheck commit attributionboth completed successfully.Limitations
Local execution was on macOS, with Linux / Node 22 covered by GitHub CI. Windows-specific execution was not validated; platform-dependent tests retain their existing skips.