Skip to content

chore: remove CHANGELOG.rst | clean up#50

Open
farhan wants to merge 1 commit into
mainfrom
farhan/remove-changelog
Open

chore: remove CHANGELOG.rst | clean up#50
farhan wants to merge 1 commit into
mainfrom
farhan/remove-changelog

Conversation

@farhan

@farhan farhan commented Jun 10, 2026

Copy link
Copy Markdown
Contributor

I think we should drop support of maintaining CHANGELOG.rst as Release notes are managed via GitHub Releases by semantic release (changelog: false in release.yml), making CHANGELOG.rst redundant.

Also removed its reference from MANIFEST.in.

@farhan farhan requested a review from feanil June 10, 2026 09:36
@codecov

codecov Bot commented Jun 10, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 82.17%. Comparing base (990f2e7) to head (e180a50).

Additional details and impacted files
@@           Coverage Diff           @@
##             main      #50   +/-   ##
=======================================
  Coverage   82.17%   82.17%           
=======================================
  Files          48       48           
  Lines        1419     1419           
  Branches      110      110           
=======================================
  Hits         1166     1166           
  Misses        221      221           
  Partials       32       32           
Flag Coverage Δ
unittests 82.17% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@feanil feanil left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think if we're dropping the changelog, we have to rely much more heavily on commit messages to convey what has changed but also why it has changed. github PRs are a good place for some conversations but we should push as much context as possible into the commit messages.

Please update your commit message with more context as to why we're doing this not just what we're doing.

Release notes are managed via GitHub Releases by semantic release
(changelog: false in release.yml), making CHANGELOG.rst redundant.
Also removed its reference from MANIFEST.in and pyproject.toml.
@farhan farhan force-pushed the farhan/remove-changelog branch from e0be651 to e180a50 Compare June 12, 2026 14:11
@farhan

farhan commented Jun 12, 2026

Copy link
Copy Markdown
Contributor Author

@feanil commit message updated

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants