Skip to content

Commit 9dd22cf

Browse files
authored
Merge pull request #4462 from ralfhandl/main-contributing-windows
main: hint for using npm scripts on Windows
2 parents 701f16f + ac7946e commit 9dd22cf

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

CONTRIBUTING.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -172,6 +172,8 @@ To do this locally, please
172172
2. Check out this repo, go to the repo root, and switch to a development branch
173173
3. Execute `npm install` (once, repeat after merging upstream changes)
174174
4. Execute `npm run build-src` after changing `src/oas.md` (this first executes `npm run validate-markdown`, which can also be run separately)
175+
> [!NOTE] Use Git Bash on Windows
176+
> This npm script calls bash scripts. Run it from [Git Bash](https://gitforwindows.org/) on Windows, or use the Windows Subsystem for Linux (WSL).
175177
5. Open output file `deploy-preview/oas.html` with a browser and check your changes
176178

177179
Please make sure the markdown validates and builds using the above steps before creating a pull request or marking a draft pull request as ready for review.

0 commit comments

Comments
 (0)