docs:Improve the contributing.md for testing purposes #992
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fix test setup documentation - missing OpenAPI spec instructions
Problem
The current contributing documentation has a broken workflow that leaves developers stuck:
# Current docs say to run this, but openapi.yml doesn't exist: npx prism mock path/to/your/openapi.yml
Issues:
openapi.yml
file that doesn't exist in the repopath/to/your/openapi.yml
Solution
Add complete, executable instructions that actually work:
Before (broken):
# you will need npm installed $ npx prism mock path/to/your/openapi.yml
After (fixed):
Changes Made
Testing
.stats.yml
containsopenapi_spec_url
Impact
Type: Documentation fix
Breaking: No
Fixes: Missing OpenAPI spec setup instructions