docs: preserve version-relative contributor links - #17
Closed
tisonkun wants to merge 2 commits into
Closed
Conversation
Why: crates.io resolves relative README links from the serde-shape package directory, but CONTRIBUTING.md lives at the repository root. Use the canonical repository URL so readers of the published crate do not land on a missing file.
Why: a link pinned to the default branch can silently change for readers of older releases. Keep the repository-relative link used by the project documentation instead of trading version stability for a crates.io rendering workaround.
tisonkun
changed the title
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
1 participant
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.
Outcome
Closed as a false positive after comparing the published behavior with
datasketches-rustand inspecting crates.io's README renderer.The original change replaced the repository-relative contributor link with a URL pinned to
main. That makes the immediate crates.io target exist, but lets documentation for an older release silently change or disappear with the default branch. The follow-up commit restores the relative link, leaving this branch with no net diff frommain.Evidence
datasketches-rustkeepsCHANGELOG.mdandCONTRIBUTING.mdrelative in its root README.datasketches 0.5.0-rc.1beneath the package'sdatasketches/directory, where the files do not exist..cargo_vcs_info.json's package path with the packaged README path and always emits GitHubblob/HEADURLs.serde-shapeshares one root README across two packages in sibling subdirectories. No single relative path can resolve to the repository root from all three source/rendering contexts.A complete crates.io workaround would require duplicated or relocated READMEs/contributor guides, symlink behavior, or generated packaging content. None is justified for this release solely to make this link clickable, so the version-relative repository documentation remains the source of truth.
Commits
c110047 docs: keep the packaged contributor link validd2f359e docs: restore the version-relative contributor linkThe second commit intentionally reverses the first without rewriting history or force-pushing.