Skip to content

Commit 2800909

Browse files
authored
Merge pull request #4436 from ralfhandl/main-sync-CONTRIBUTING.md
main: sync CONTRIBUTING.md from dev
2 parents f3c113a + 41b6657 commit 2800909

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

CONTRIBUTING.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -163,6 +163,19 @@ This might apply to, for example, Markdown files, automation, and scripts.
163163
For all pull requests, if they should not be merged yet for any reason (they depend on something else, you would like feedback from a specific reviewer), mark them as draft and they will not be merged while in that state.
164164
Draft pull requests can still be reviewed while in draft state.
165165

166+
### Preview specification HTML locally
167+
168+
The markdown source files are converted to HTML before publishing.
169+
To do this locally, please
170+
171+
1. Install [Node.js](https://nodejs.org/)
172+
2. Check out this repo, go to the repo root, and switch to a development branch
173+
3. Execute `npm install` (once, repeat after merging upstream changes)
174+
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+
5. Open output file `deploy-preview/oas.html` with a browser and check your changes
176+
177+
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.
178+
166179
## Reviewers
167180

168181
> [!NOTE]

0 commit comments

Comments
 (0)