Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve documentation for dev containers setup #20419

Closed
gnuechtel opened this issue Nov 25, 2023 · 0 comments · Fixed by #23479
Closed

Improve documentation for dev containers setup #20419

gnuechtel opened this issue Nov 25, 2023 · 0 comments · Fixed by #23479

Comments

@gnuechtel
Copy link
Contributor

Documentation issue

I found it difficult to setup the Nx monorepo for contribution and even had to do some workaround to run it on my machine.

Don't get me wrong: The contribution guide is great! However, some tiny details would help for the dev containers setup. Surprisingly as a Rust newbie I had no problems with it, but pnpm made trouble.

I had to do setup the following in.npmrc to bring it to work:

package-import-method=clone-or-copy 

Is there a specific documentation page you are reporting?

https://github.com/nrwl/nx/blob/master/CONTRIBUTING.md#development-workstation-setup

Additional context or description

I think, in my special case, thats a pnpm issue on macOS.

Suggestion

Maybe alternative setups may be described in the contribution guide like other package managers or some troubleshooting FAQ for common setup problems.

@gnuechtel gnuechtel changed the title Setup Nx development workflow for contribution Improve documentation for dev containers setup Nov 25, 2023
isaacplmann added a commit that referenced this issue May 21, 2024
Updates the devcontainer so that it has the correct version of pnpm

Fixes #20419
FrozenPandaz pushed a commit that referenced this issue May 22, 2024
Updates the devcontainer so that it has the correct version of pnpm

Fixes #20419

(cherry picked from commit 89fdd42)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants