Skip to content

Commit 23829b0

Browse files
committed
docs: improve developer guide for pnpm and windows
Improves the developer guide for pnpm and Windows. See for the Windows change: angular#29705.
1 parent 20c64ba commit 23829b0

File tree

1 file changed

+21
-4
lines changed

1 file changed

+21
-4
lines changed

docs/DEVELOPER.md

+21-4
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,13 @@
55
To get started locally, follow these instructions:
66

77
1. If you haven't done it already, [make a fork of this repo](https://github.com/angular/angular-cli/fork).
8-
1. Clone to your local computer using `git`.
9-
1. Make sure that you have Node `v18.19` or higher installed. See instructions [here](https://nodejs.org/en/download/).
10-
1. Make sure that you have `yarn` installed; see instructions [here](https://yarnpkg.com/lang/en/docs/install/).
11-
1. Run `yarn` (no arguments) from the root of your clone of this project to install dependencies.
8+
2. If you are on Windows, see [the extra steps needed for contributing on Windows](#windows)
9+
3. Clone to your local computer using `git`.
10+
4. Make sure that you have Node `v20.18.1` or higher installed. See instructions [here](https://nodejs.org/en/download/).
11+
5. Install `pnpm`.
12+
- You can install pnpm by running `npm i -g pnpm@9`.
13+
- See detailed instructions [here](https://pnpm.io/installation).
14+
6. Run `pnpm install` from the root of your clone of this project to install dependencies.
1215

1316
## Building and Installing the CLI
1417

@@ -170,3 +173,17 @@ Adding a package to this repository means running two separate commands:
170173

171174
For private packages, you will need to add a `"private": true` key to your package.json manually.
172175
This will require re-running the template admin script.
176+
177+
## Windows
178+
179+
To contribute to Angular using a Windows machine, you need to use the [Windows Linux Subsystem](https://learn.microsoft.com/en-us/windows/wsl/about) (also known as WSL).
180+
Installing WSL on your machine requires a few extra steps, but we believe it's generally useful for developing on Windows:
181+
182+
1. Run `wsl --install` from Powershell (as administrator).
183+
2. Restart your machine.
184+
3. Enter the WSL environment by running: `wsl`.
185+
4. Continue with the developer guide as if you were on a native Linux system.
186+
187+
For a more detailed guide, refer to the official Microsoft documentation: [Installing WSL](https://learn.microsoft.com/en-us/windows/wsl/install).
188+
189+
**Note:** Angular continues to support native Windows development via the `ng` CLI and rigorously tests on Windows for every code change. This recommendation specifically applies to contributing to the Angular codebase itself.

0 commit comments

Comments
 (0)