docs: fix stale paths in CONTRIBUTING.md - #1871
Merged
woodruffw merged 1 commit intoAug 12, 2026
Merged
Conversation
The development setup steps contain two stale paths that break for anyone following them: - `git clone .../sigstore-python` creates `sigstore-python/`, but the next line says `cd sigstore`. The `cd` dates back to 0fd62c5, when the clone URL still pointed at `sigstore/sigstore`; 3929f79 updated the URL two days later without updating the `cd`. - The X.509 test case section links to `test/unit/assets/x509`, which no longer exists. a966b3e (sigstore#1089) moved `test/unit/assets/` to `test/assets/` and updated the `gen-x509-testcases` Makefile target, but not these two links, so both currently 404 on GitHub. Signed-off-by: Aroh Maurya <aroh3006@gmail.com>
woodruffw
approved these changes
Aug 12, 2026
Member
|
/gcbrun |
Member
|
@aroh3006 In the future, please write PR descriptions in your own words. |
Contributor
Author
|
@woodruffw gotcha thanks for the feedback |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary
Two stale paths in the development setup instructions break for anyone following them.
1.
cd sigstoreafter cloning (line 26)git clonecreatessigstore-python/, so the very first step of the contributorsetup fails.
git blameshows why:0fd62c5addedcd sigstoreon 2022-04-26 when theclone URL still pointed at
sigstore/sigstore, and3929f79updated the URL tosigstore-pythontwo days later without updating thecd.2. Broken links in "X.509 test cases" (lines 94, 97)
Both links point at
test/unit/assets/x509, which no longer exists, so they 404 onGitHub.
a966b3e(#1089) movedtest/unit/assets/totest/assets/and updated thegen-x509-testcasesMakefile target accordingly, but these two links were missed.The corrected path matches what the Makefile already runs
(
python test/assets/x509/build-testcases.py), which thex509-testcasesCI jobexercises on every run.
How reviewers can check this:
git clonethe repo and trycd sigstore; and clickthe two
test/unit/assets/x509links in the renderedCONTRIBUTING.mdonmain.Release Note
N/A — contributor documentation only.
Documentation
This change is the documentation fix; it is confined to
CONTRIBUTING.mdand needs nochange to https://docs.sigstore.dev.
I did not open an issue first, since this is a self-evident path correction rather than a
behavioural change — happy to file one if you'd prefer.
Testing performed: no code is touched, so no test or lint behaviour changes (
make lintcovers only the Python sources). I verified the change directly:
git cloneof this repoproduces
sigstore-python/;test/assets/x509/build-testcases.pyexists onmainwhiletest/unit/assets/x509/does not; both edited links now resolve to real paths; andgit grep test/unit/assetsreturns nothing after the change.