Fix stale README references for CI and testing#4650
Fix stale README references for CI and testing#4650Bojun-Vvibe wants to merge 1 commit intofacebook:devfrom
Conversation
|
Hi @Bojun-Vvibe! Thank you for your pull request and welcome to our community. Action RequiredIn order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you. ProcessIn order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA. Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with If you have received this in error or have any questions, please contact us at cla@meta.com. Thanks! |
Repo: facebook/zstd (⭐ 25000)
Type: docs
Files changed: 1
Lines: +5/-3
What
Updates the top-level README to point readers at the current CI workflow location and the actual local test script path. The change replaces a dead reference to
.travis.ymlwith.github/workflows/, and fixes the testing instructions fromplayTest.shinsrc/teststotests/playTests.shfrom the repository root.Why
The existing README sends contributors to a file that no longer exists and documents a test command that cannot work as written. Fixing both keeps the first-run contributor experience accurate, avoids avoidable confusion during local validation, and aligns the README with the current repository layout.
Testing
Verified the referenced paths locally in the repository:
.github/workflows/exists and contains the active CI workflow files.tests/playTests.shexists.No runtime checks were needed because this is a documentation-only change.
Risk
Low - documentation-only update that aligns README instructions with files already present in the repo.