GitHub user visortelle edited a discussion: Group release notes by improvement/bug instead of affected component
I usually read release notes this way: - Aha, new feature. Interesting... - I missed this! Maybe it could fix my problem. - There are some bug fixes. Most times I just skip it. I usually subscribe to bug GitHub issues or bug-fix PRs I'm interested in and receive notifications when it fixed. The Pulsar release notes are grouped by component: https://pulsar.apache.org/release-notes/versioned/pulsar-3.2.1/ <img width="501" alt="Screenshot 2024-03-23 at 7 47 40 PM" src="https://github.com/apache/pulsar/assets/9302460/1266cb1e-b7f8-452b-a117-fda2e9eb3818";> I can't just quickly scan it. Reading it requires much attention. For comparison. Kubernetes: <img width="1079" alt="Screenshot 2024-03-23 at 7 48 54 PM" src="https://github.com/apache/pulsar/assets/9302460/bfc4b602-3f9f-4b61-b99d-ab9db4d13543";> Kafka: <img width="887" alt="Screenshot 2024-03-23 at 7 49 34 PM" src="https://github.com/apache/pulsar/assets/9302460/a8a80fd7-a91b-4535-b865-33dbe31ff503";> Hadoop: <img width="1235" alt="Screenshot 2024-03-23 at 7 51 31 PM" src="https://github.com/apache/pulsar/assets/9302460/d08d7d06-d2ae-4fbe-81de-ac3a2fde0f2b";> Bookkeeper: <img width="589" alt="Screenshot 2024-03-23 at 7 54 33 PM" src="https://github.com/apache/pulsar/assets/9302460/e7f1fe3d-f5dc-4cba-a909-47cdbd5f2af5";> Probably it would make sense to group it by component **and** by type: - Broker - Improvements - ... - Bug fixes - ... - Pulsar Functions - Improvements - ... - Bug fixes - ... - Pulsar IO - Improvements - ... - Bug fixes - ... The pulsar/pulsar repo follows the conventional commits, but for some reason doesn't use it for release notes. Having full commit messages simply sorted alphabetically could improve release note readability. GitHub link: https://github.com/apache/pulsar/discussions/22334 ---- This is an automatically sent email for [email protected]. To unsubscribe, please send an email to: [email protected]
