-
Notifications
You must be signed in to change notification settings - Fork 2
[task] Verify first-time contributor setup from a clean clone #2
Copy link
Copy link
Closed
Labels
area: docsProject documentation and contributor guidance.Project documentation and contributor guidance.good first issueA scoped task that is suitable for a first contribution.A scoped task that is suitable for a first contribution.good for beginnerA student-friendly starter task with clear scope, success criteria, and verification steps.A student-friendly starter task with clear scope, success criteria, and verification steps.kind: docsDocumentation-only changes or issues.Documentation-only changes or issues.
Milestone
Metadata
Metadata
Assignees
Labels
area: docsProject documentation and contributor guidance.Project documentation and contributor guidance.good first issueA scoped task that is suitable for a first contribution.A scoped task that is suitable for a first contribution.good for beginnerA student-friendly starter task with clear scope, success criteria, and verification steps.A student-friendly starter task with clear scope, success criteria, and verification steps.kind: docsDocumentation-only changes or issues.Documentation-only changes or issues.
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.mddocs/onboarding.mddocs/development.mddocs/environments.mddocs/tooling.mdDepends 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
Definition of done
README.md,docs/onboarding.md,docs/development.md, anddocs/environments.mdfrom a clean clone.Verification
pnpm install --frozen-lockfilepnpm checkpnpm desktop:buildContributor 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.