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

Add sections to the CHANGELOG #5040

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

steviez
Copy link

@steviez steviez commented Feb 19, 2025

Add sections, such as CLI and validator, to CHANGELOG to introduce some grouping of items

Problem

There are several different types of "consumers" of the contents of the agave repo. These different consumers might care about different things (validators, developers, basic CLI users, etc), but the changelog currently has information for these different groups interleaved.

Summary of Changes

Introduce topic sections headers under reach release. Additionally, add headers for "Changes", "Breaking", "Deprecations" and whatever else may come up to reduce the indentations on the bullets

Add sections, such as CLI and validator, to CHANGELOG to introduce some
grouping of items
Copy link
Author

@steviez steviez left a comment

Choose a reason for hiding this comment

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

For now, I only did v2.2 section as a proof of concept / to gather feedback on. If folks like the format, I think I would proceed and update the previous releases to match the formatting.

@steviez steviez requested a review from willhickey February 19, 2025 19:52
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