Skip to content

[maintainer] README "Hack on the framework" should state what its commands cost on a fresh clone — pnpm objectui:build ≈ 10 min to get the Console, pnpm test ≈ 54 min — and point to turbo's --affected path for a contributor's own change #22164

Description

@objectstack-fleet

Filing gate: ③ task dispatched by the maintainer, quoted verbatim below; the durations are class (a) measurements from this session on a fresh clone of main.
reach: README.md lines 220–229 ("Hack on the framework"), read by every contributor first; measured on a fresh clone (Node v22.22.0, pnpm 10.31.0, 4 vCPU-class container): pnpm install 16 s · pnpm build 6 m 54 s (72 turbo tasks) · pnpm objectui:build 10 m 36 s (shallow-clones objectui, builds the Console) · pnpm test 54 m 03 s (135 turbo tasks, 62 cached from the build).
Reader: domain:devx seat (README.md "Hack on the framework"; CONTRIBUTING.md once #22156 rewrites it).
Dedup: search_issues "README Hack on the framework pnpm test takes long objectui:build duration affected tests turbo --affected contributor guidance" → 0 hits. Related: #22155 (the Console step is missing from the same section).
Filed on the maintainer's instruction in this session (category ③, quoted verbatim): 「贡献者路径要说清时间成本。 README 三条命令拿不到 Console(已立 #22155),补上的 pnpm objectui:build 要 10 分钟;pnpm test 全量 54 分钟。建议 README "Hack on the framework" 直接写出这两个耗时,并指向 turbo --affected 的局部测试用法,否则新人会以为自己环境有问题。」

Today

pnpm install     # Node 22+, pnpm 10 (corepack enable)
pnpm build       # build all packages
pnpm dev         # showcase example: REST + Console on :3000
pnpm test        # run the test suite

Four commands, no durations, no Console step, and pnpm test runs 135 tasks across 72 packages. A newcomer who runs it and sees nothing finish for twenty minutes concludes their machine or install is broken (this session did, and went looking for a hang before the log caught up). The same section says "REST + Console" while the Console needs the undocumented ten-minute step.

Asked for

The block states what each line costs and what to run instead for a change:

pnpm install          # ~20 s
pnpm build            # ~7 min, 72 packages — required once; nothing builds implicitly
pnpm objectui:build   # ~10 min, clones objectui at the pinned SHA; only needed for the Console at /_console/
pnpm dev              # showcase example: REST (+ Console if built) on :3000
pnpm test             # full suite, ~1 h — CI runs this; locally prefer the two lines below
pnpm turbo run test --affected        # only packages your diff reaches (AGENTS.md: turbo ls --affected)
pnpm --filter @objectstack/<pkg> test # one package

Durations are order-of-magnitude, stated as "≈ on a 4-core laptop", and live in one place (README) with CONTRIBUTING.md pointing at it rather than repeating them.


Generated by Claude Code

Activity

  1. objectstack-fleet commented on Oct 8, 2026

    @objectstack-fleet
    ContributorAuthor

    Path: the road — start: a contributor knows what the commands cost | 缺项 | P3

    Triage: first grade, documentation · priority:p3 · domain:devx · area:devpath · pm:queue (finding removed). The maintainer's direction, as dispatched

    Triage seat (objectstack-wide, seat post #6015) · session_01AavokzJ5DndAwitDXvKy4U · 2026-10-08T05:13Z. ⛔ Not a claim, ⛔ not a dispatch.

    Triage: lands in README.md ("Hack on the framework") ⇒ domain:devx; rationale: README.md is that lane's. Read on main ec8f37c890.

  2. objectstack-fleet commented on Oct 8, 2026

    @objectstack-fleet
    ContributorAuthor

    Claim: PM loop round 8 · member of the #22155 bundle (full claim on #22155)
    Session: session_01VF48aw8RPG6wzDnMgp6rtw
    Account: os-justin
    Branch: claude/issue-22155-readme-contributor-path
    Seat: domain:devx#2
    Clause-②: no
    Responsibility: n/a — not a defect card
    Thread-read: 6052823678
    This card's half: README "Hack on the framework" states each command's measured cost, and points to turbo's --affected path, per the maintainer's direction quoted in the body. The bundle's one PR closes it alongside #22155.

  3. objectstack-fleet commented on Oct 8, 2026

    @objectstack-fleet
    ContributorAuthor

    Landed with its bundle anchor #22155: PR #22224 → 5accac4a34 (record on #22155). README "Hack on the framework" now states each command's measured cost and the --affected path, per the maintainer's direction. pm:dispatched is removed in the same act. · domain:devx#2 · 2026-10-08T09:03Z

  4. added a commit that references this issue on Oct 9, 2026
    5accac4
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

area:devpathThe road — create, dev, verify, publish/install, connect an agent, iteratedocumentationImprovements or additions to documentationdomain:devxpriority:p3

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions