Skip to content

Clarify local validation commands in CONTRIBUTING.md#5443

Open
miqui wants to merge 1 commit into
OAI:mainfrom
miqui:contributing-local-validation
Open

Clarify local validation commands in CONTRIBUTING.md#5443
miqui wants to merge 1 commit into
OAI:mainfrom
miqui:contributing-local-validation

Conversation

@miqui

@miqui miqui commented Jul 23, 2026

Copy link
Copy Markdown
Contributor

List the individual npm scripts (validate-markdown, format-markdown, build-src, test) so contributors can pick the fast lint/link-check loop while editing versus the full build/test pass before opening a PR.

  • no schema changes are needed for this pull request

List the individual npm scripts (validate-markdown, format-markdown,
build-src, test) so contributors can pick the fast lint/link-check
loop while editing versus the full build/test pass before opening a PR.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@miqui
miqui requested review from a team as code owners July 23, 2026 21:01
@miqui
miqui removed the request for review from a team July 23, 2026 21:07
@handrews

Copy link
Copy Markdown
Member

@miqui please make sure this won't conflict with #5424 which updates this documentation based on changes to the scripts due to shared build infrastructure. It might be easier to update that part after getting the build system updated.

@miqui

miqui commented Jul 23, 2026

Copy link
Copy Markdown
Contributor Author

@handrews good call, will check, thanks

@miqui

miqui commented Jul 24, 2026

Copy link
Copy Markdown
Contributor Author

hi @handrews - just checked your PR and there is no conflict. In package.json it keeps the exact same npm script names I documented in my PR: validate-markdown, format-markdown, build-src, test. Your PR is only swapping their internal implementation from inline npx/bash calls to thin wrappers around a new @oai/build-infra CLI (oai-spec-validate-markdown, etc.).

We are good.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants