Skip to content

Commit b9c0963

Browse files
authored
Merge pull request OAI#4494 from OAI/ralfhandl-main-contributing-note
main: CONTRIBUTING note on `buid-src` for Windows users
2 parents 1b84b6f + 8be81a5 commit b9c0963

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

CONTRIBUTING.md

+3-2
Original file line numberDiff line numberDiff line change
@@ -165,15 +165,16 @@ Draft pull requests can still be reviewed while in draft state.
165165

166166
### Preview specification HTML locally
167167

168+
> [!NOTE]
169+
> `npm run build-src` calls bash scripts. Use [Git Bash](https://gitforwindows.org/) on Windows, or use the Windows Subsystem for Linux (WSL).
170+
168171
The markdown source files are converted to HTML before publishing.
169172
To do this locally, please
170173

171174
1. Install [Node.js](https://nodejs.org/)
172175
2. Check out this repo, go to the repo root, and switch to a development branch
173176
3. Execute `npm install` (once, repeat after merging upstream changes)
174177
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).
177178
5. Open output file `deploy-preview/oas.html` with a browser and check your changes
178179

179180
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)