Skip to content

docs: add repository structure and contributor guidelines - #250

Merged
ZouR-Ma merged 7 commits into
mainfrom
docs/complete-module-agent-guidelines
Oct 15, 2026
Merged

ZouR-Ma merged 7 commits into
mainfrom
docs/complete-module-agent-guidelines

Conversation

@ZouR-Ma

@ZouR-Ma ZouR-Ma commented Oct 14, 2026 •

Copy link
Copy Markdown
Collaborator

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

  • Add 15 English AGENTS.md files covering the repository, packages, CLI host and UI, generic harness, documentation, scripts, release packaging, and plugins.
  • Map the actual project directories and the owners of Agent Loop, sessions, context, providers, tools, configuration, orchestration, themes, and host protocols. Keep coding-agent subdirectory guidance in its package-level file.
  • Add development and testing guides for types, abstraction, errors, asynchronous cleanup, contributor ownership, interface handoffs, fixtures, consumer-level tests, and validation evidence.
  • Require English Conventional Commit titles and English collaboration text; add a PR template and review checklist for compatibility, model-visible behavior, affected consumers, and verification.
  • Preserve the existing attribution policy and CLAUDE.md reference, 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 check passed on macOS with Node 24.3.0 and pnpm 9.15.9, including types, public-source boundaries, repository guards, and browser bundle smoke.
  • ./test.sh passed 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...HEAD passed.
  • Checked 87 relative links, all 35 directories in the project structure, and 14 documented test entry points against the checkout. Confirmed the original attribution policy and CLAUDE.md were preserved.
  • GitHub CI passed for a90bfa5: Linux / Node 22 build-check-test and Check commit attribution both 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.

@ZouR-Ma
ZouR-Ma force-pushed the docs/complete-module-agent-guidelines branch from ec0519b to 8370fff Compare October 14, 2026 08:24
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
ZouR-Ma force-pushed the docs/complete-module-agent-guidelines branch from 8370fff to 976a534 Compare October 14, 2026 09:27
@ZouR-Ma ZouR-Ma changed the title docs: 补齐 Step-Code 仓库与模块 AGENTS 规范 docs: add repository and module agent guidelines Oct 14, 2026
@ZouR-Ma ZouR-Ma changed the title docs: add repository and module agent guidelines docs: add repository structure and contributor guidelines Oct 15, 2026
@ZouR-Ma
ZouR-Ma merged commit 58c7c89 into main Oct 15, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant