Skip to content

[task] Verify first-time contributor setup from a clean clone #2

@phongndo

Description

@phongndo

Area

Docs

Goal

Verify that a first-time contributor can clone the repo, install dependencies, and run the documented checks from scratch.

Why this matters

This is the first safety check for the public repo. If a new UC Davis contributor cannot get the project running from the docs, the project is not ready for onboarding.

Relevant files

  • README.md
  • docs/onboarding.md
  • docs/development.md
  • docs/environments.md
  • docs/tooling.md

Depends on

None. This can be claimed immediately.

Current behavior

The repo has setup docs for both mise and Nix, but they need to be verified from a clean clone by someone following them like a new contributor.

Target behavior

A new contributor can follow the docs, install dependencies, and run the documented checks without needing private maintainer knowledge.

Out of scope

  • Implementing product features.
  • Rewriting the full documentation set.
  • Changing the supported toolchain without a separate discussion.

Definition of done

  • A contributor follows README.md, docs/onboarding.md, docs/development.md, and docs/environments.md from a clean clone.
  • Any missing or confusing setup step is fixed in docs.
  • The issue comment or PR description notes the OS, setup path, commands used, failed commands, and fixes.

Verification

  • pnpm install --frozen-lockfile
  • pnpm check
  • pnpm desktop:build
  • Include the OS, shell, setup path, and any setup problems found.

Contributor notes

This is a good first issue. If everything works, the contribution can be a short docs PR that records the verified setup path and any small clarifications.

Metadata

Metadata

Assignees

No one assigned

    Labels

    area: docsProject documentation and contributor guidance.good first issueA scoped task that is suitable for a first contribution.good for beginnerA student-friendly starter task with clear scope, success criteria, and verification steps.kind: docsDocumentation-only changes or issues.

    Type

    No type

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions