Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update changelog #1460

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

Update changelog #1460

wants to merge 6 commits into from

Conversation

joeycarter
Copy link
Contributor

@joeycarter joeycarter commented Jan 15, 2025

This is a proposal for a slightly modified changelog format.

Previously, the changelog header for the most recent stable release included (current release) appended to the release version, and the latest development version included (development release). These parentheticals in the changelog headers are largely superfluous, since it should be clear from context which is the most recent stable release and the development version, whether you are on the stable or latest branches of the documentation webpage, respectively: it's the first one in the list! Furthermore, "development release" is a misnomer since the "latest" version of the software has not been formally released.

I propose to drop the (current release), so that the release notes for the stable branch of the docs appear as

Release v0.10.0
...
Release v0.9.0
...

And to append -dev to the version under development, so that the release notes for the latest branch of the docs appear as

Release v0.11.0-dev
...
Release v0.10.0
...
Release v0.9.0
...

This PR also includes some editorial changes to the changelog (fixed typos, added missing punctuation, reworded some changelog entries).

@joeycarter joeycarter requested review from josh146 and a team January 15, 2025 15:59
Copy link

codecov bot commented Jan 15, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.70%. Comparing base (64f3aad) to head (2d1c4bd).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1460   +/-   ##
=======================================
  Coverage   96.70%   96.70%           
=======================================
  Files          76       76           
  Lines        8173     8173           
  Branches      846      846           
=======================================
  Hits         7904     7904           
  Misses        215      215           
  Partials       54       54           

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

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.

1 participant