Skip to content

Commit 8a2bb17

Browse files
committed
Preview and lint spec changes
1 parent 126d46a commit 8a2bb17

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

CONTRIBUTING.md

+15
Original file line numberDiff line numberDiff line change
@@ -163,6 +163,21 @@ 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`
175+
5. Open output file `deploy-preview/oas.html` with a browser
176+
177+
Before creating a pull request or marking a draft pull request as ready for review, please
178+
179+
6. Execute `npm run validate-markdown` and fix any reported problems in `src/oas.md`
180+
166181
## Reviewers
167182

168183
> [!NOTE]

0 commit comments

Comments
 (0)