Skip to content

[docs] Align contributor setup and hook instructions with current tooling #2148

Open

Description

@Jarvis636431

Problem

On develop 0d65f2ad, the contributor guides differ from the commands a new contributor actually runs:

  • The quick start installs Python dependencies but omits dashboard/npm ci, even though make all immediately invokes frontend Prettier.
  • The documented Node 18 prerequisite does not satisfy current locked dependencies, including an ESLint visitor-keys requirement supporting Node 22 from 22.13.
  • The guides describe the hook as make all; .githooks/pre-commit actually invokes make precommit (testmon-selected tests), then the dashboard build.
  • make check-all runs full-stack lint/type checks and backend tests, but not Vitest; the frontend test command is not shown in the setup flow.
  • The root README-only hook exception is not described.

Proposed solution

Calibrate the English/Chinese quick start and AGENTS hook guidance against the actual Makefile and hook: install npm dependencies, choose develop, document a compatible Node version, show the frontend test command, and distinguish the local hook from the full backend ship gate.

No hook or application behavior change is proposed.

Related work / duplicate check

Verification

Cross-checked Makefile targets, actual hook commands and both language sections. Full backend ship gate on the same source base passed: 4969 passed, 34 skipped.

Actual documentation diff

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