Fix README links for PyPI rendering

[wyli]

Summary

• replace repo-relative README links with absolute GitHub URLs so PyPI long descriptions do not render broken links
• add a package metadata test that rejects relative README links in future releases

Testing

• python -m pytest -q -o addopts='' tests/unit/test_package_data.py
• python -m ruff check tests/unit/test_package_data.py
• python -m black --check tests/unit/test_package_data.py
• python -m pytest -q -o addopts='' tests/unit
• git diff --check

AI-assisted: Created with Codex/GPT at the user's request.

Summary by CodeRabbit

• Documentation

  • Updated GitHub links in the Contributing section to use main-branch absolute references instead of relative paths, improving documentation stability across distribution formats.

• Tests

  • Added validation to ensure all links in the packaged README are compatible with PyPI rendering and contain no invalid relative link references.

[github-actions]

Dependency Review

✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.

Scanned Files

None

[coderabbitai]

Caution

Review failed

The head commit changed during the review from 63e236b to 5ed9285.

Walkthrough

The Contributing section of README.md replaces relative file links with absolute GitHub main-branch URLs for CONTRIBUTING.md and .github/CI.md. A new test in tests/unit/test_package_data.py scans all Markdown link targets in README.md and fails if any relative (non-anchor, non-URL, non-mailto) links are found.

Changes

README PyPI Link Fix and Enforcement

Layer / File(s)	Summary
README Contributing section: relative → absolute links README.md	Replaces relative Markdown paths for CONTRIBUTING.md and .github/CI.md with absolute GitHub main-branch URLs in the Contributing section.
PyPI link validation test tests/unit/test_package_data.py	Adds re import, a README Path constant, a _readme() helper (skips if file is absent), and test_readme_links_are_valid_for_pypi_rendering which fails if any relative Markdown link targets are detected in README.md.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

🚥 Pre-merge checks | ✅ 4

✅ Passed checks (4 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title directly and concisely summarizes the main change: fixing README links for PyPI rendering.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[jcfr]

Nitpick: Tagged release would reference files from main which may not always be desired.