dcramer / dcramer/peated

Order of Execution for PNPM Commands

Open
#128 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
103
Forks
18
Avg merge
1h 19m
Merged PRs (30d)
555

Description

The documentation suggests running pnpm setup without explicitly mentioning that pnpm install should be executed beforehand. This may lead to potential issues during the setup process.

Proposed Solution:
Update the documentation to explicitly instruct users to run pnpm install before executing pnm setup. This will ensure a smooth setup process with all required dependencies in place.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Locate the documentation that describes the setup commands and find the instruction for pnpm setup. Update the sequence so pnpm install is explicitly listed first, then verify the surrounding setup guidance remains consistent.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.