Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR aligns the 1.3.5 changelog entry with the actual scope of the patch release and improves PyPI presentation/metadata by introducing a PyPI-safe README and updating packaging metadata accordingly.
Changes:
- Switched PyPI long description source to a new
README-pypi.mdwith PyPI-safe absolute links/badges. - Expanded
pyproject.tomlproject metadata (keywords, classifiers, project URLs) for PyPI discoverability. - Updated
CHANGELOG.mdto reflect the corrected1.3.5entry and scope, and added guidance to keepREADME.mdandREADME-pypi.mdaligned.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
pyproject.toml |
Uses README-pypi.md for the published long description and adds richer PyPI-facing metadata/URLs. |
README-pypi.md |
Adds a PyPI-compatible README with absolute links and a concise quickstart for PyPI rendering. |
CHANGELOG.md |
Adjusts the 1.3.5 entry to match the actual packaging/metadata alignment work. |
.github/copilot-instructions.md |
Documents repo process guidance to keep the PyPI README aligned with the GitHub README. |
eschaar
force-pushed
the
fix/changelog-1-3-5-alignment
branch
from
be49d45 to
535cc50
Compare
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
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
1.3.5changelog entry to reflect the actual scope of this update.README-pypi.md) with stronger developer experience and working absolute links/badges.README-pypi.mdinpyproject.toml.README.mdandREADME-pypi.mdaligned.Why
PyPI and GitHub render Markdown differently. The previous setup caused broken links/media behavior on PyPI and made package metadata less discoverable than it should be.
This change makes PyPI presentation reliable, improves package search relevance for the intended audience, and keeps release/changelog documentation aligned with actual shipped scope.
Version impact