Skip to content

CONTRIBUTING.md structure section: top-level src/ note is stale and multimodal/ is missing from the tree #1989

Description

@sxh313

Description

CONTRIBUTING.md is the entry point both README.md:282 and README.zh-CN.md:279 send contributors to, and its "Structure of the project" section now misdescribes the repository in two ways that cost a newcomer time.

1. The note claims a top-level src/ directory that no longer exists — and the same code block contradicts it.

CONTRIBUTING.md:89:

Note: The src directory is located in the top-level directory instead of the apps/{main,preload,renderer} directories because Electron Forge previously did not support Pnpm's hoisting mechanism(electron/forge#2633), requiring the src directory to be placed in the top-level directory.

Measured on main:

  • ls -d src → no such directory; the desktop app's sources live in apps/ui-tars/src/{main,preload,renderer}.
  • The tree a few lines above already shows them there, so the note contradicts the block it annotates.
  • Upstream electron/forge#2633 ("Support pnpm"), cited as the reason, was closed on 2025-02-11 — the constraint the note documents is gone.

A contributor who trusts the note will create src/main/... at the repository root, where nothing picks it up.

2. The tree omits multimodal/, which is where the headline product of the README actually lives.

ls multimodal/ → agent-tars/, benchmark/, gui-agent/, omni-tars/, tarko/, websites/ (plus its own CONTRIBUTING.md). README.md / README.zh-CN.md open with "TARS is a Multimodal AI Agent stack … Agent TARS and UI-TARS-desktop", and Agent TARS/Tarko packages (@agent-tars/cli, @tarko/*) are all under multimodal/ — a contributor following this file cannot find them.

The packages/agent-infra listing is likewise stale: ls packages/agent-infra/ returns 11 directories while the tree lists 7 — create-new-mcp, mcp-benchmark, mcp-http-server and mcp-shared are missing. docs/ (the directory the same file's "Documentation" section tells contributors to edit) and examples/ (referenced from docs/preset.md) are missing from the tree too.

Expected behaviour

The structure section matches the repository: sources described where they are (apps/ui-tars/src), and multimodal/, docs/, examples/ plus the current agent-infra packages listed.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions