You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+12-5Lines changed: 12 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -179,16 +179,23 @@ Draft pull requests can still be reviewed while in draft state.
179
179
> [!NOTE]
180
180
> `npm run build-src` calls bash scripts. Use [Git Bash](https://gitforwindows.org/) on Windows, or use the Windows Subsystem for Linux (WSL).
181
181
182
-
The markdown source files are converted to HTML before publishing.
183
-
To do this locally, please
182
+
Before creating a pull request or marking a draft pull request as ready for review, validate your changes locally:
184
183
185
184
1. Install [Node.js](https://nodejs.org/)
186
185
2. Check out this repo, go to the repo root, and switch to a development branch
187
186
3. Execute `npm install` (once, repeat after merging upstream changes)
188
-
4. Execute `npm run build-src` after changing `src/oas.md` (this first executes `npm run validate-markdown`, which can also be run separately)
189
-
5. Open output file `deploy-preview/oas.html` with a browser and check your changes
187
+
4. Run the commands relevant to what you changed:
190
188
191
-
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.
189
+
| Command | What it does |
190
+
| ------- | ------------- |
191
+
|`npm run validate-markdown`| markdownlint + link check only — fast loop while editing |
192
+
|`npm run format-markdown`| auto-fix markdownlint violations |
193
+
|`npm run build-src`| full check: validation, HTML build, schema publish |
194
+
|`npm test`| runs the JSON Schema and build tooling test suites |
195
+
196
+
5. After `npm run build-src`, open output file `deploy-preview/oas.html` with a browser and check your changes
197
+
198
+
Please make sure the markdown validates and builds, and that `npm test` passes, before creating a pull request or marking a draft pull request as ready for review.
0 commit comments