docs: drop stale CHANGELOG.md + add maintainer contact#170
Merged
Conversation
…, add maintainer contact Two small README hygiene changes: 1. Drop CHANGELOG.md entirely. The file was stale by three releases — its `## Unreleased` section still described v0.3.0-era work, and every release since 0.3.x landed only as GitHub Release notes. Maintaining it would mean writing every release twice; the inline release notes we publish at tag time are already richer than the per-version bullet-list format anyway. The README's Documentation table now points "Release notes" at the GitHub Releases page directly, which is already the canonical channel (publish workflows fire from it, `gh release view` reads from it, PyPI's "Homepage" links to it). 2. Add a maintainer contact line in the footer so readers have a direct way to reach out — currently the only contact path is filing an issue, which is fine for bugs but discourages "I'm trying this out, can I talk to you" conversations. No code changes. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
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.
Two small README hygiene changes.
1. Drop `CHANGELOG.md`
The file was stale by three releases — its `## Unreleased` section still described v0.3.0-era work, and every release since landed only as GitHub Release notes. The inline release notes we publish at tag time are already richer than the per-version-bullet-list format that Keep-a-Changelog expects, so maintaining `CHANGELOG.md` would mean writing every release twice.
GitHub Releases is already the canonical channel:
The README's Documentation table now points "Release notes" at the GitHub Releases page directly.
2. Add maintainer contact in the footer
Currently the only contact path from the README is filing an issue, which is fine for bugs but discourages "I'm trying this out, can I talk to you" conversations. New footer line:
No code changes.
🤖 Generated with Claude Code