docs:Improve the contributing.md for testing purposes#992
docs:Improve the contributing.md for testing purposes#992fede-kamel wants to merge 1 commit intoanthropics:mainfrom
Conversation
docs:Improve the contributing.md for testing purposes
b6fa267 to
2dac25f
Compare
PR Updated - Rebased onto Latest MainI've rebased this PR onto the latest Summary of ChangesThis PR fixes the broken test setup documentation by providing complete, step-by-step instructions for:
Current Issue in Main BranchThe existing docs still have the placeholder that doesn't work: $ npx prism mock path/to/your/openapi.yml # ❌ File doesn't existThis PR provides clear, executable instructions that new contributors can actually follow. Requesting review from: Would appreciate feedback on these documentation improvements to help new contributors set up their test environment successfully. Thanks! |
|
Closing — the CONTRIBUTING.md has been updated on main with proper instructions ( |
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.ymlIssues:
openapi.ymlfile that doesn't exist in the repopath/to/your/openapi.ymlSolution
Add complete, executable instructions that actually work:
Before (broken):
# you will need npm installed $ npx prism mock path/to/your/openapi.ymlAfter (fixed):
Changes Made
Testing
.stats.ymlcontainsopenapi_spec_urlImpact
Type: Documentation fix
Breaking: No
Fixes: Missing OpenAPI spec setup instructions