open-telemetry/opentelemetry-ruby-contrib

Improve changelogs

開放

#987 建立於 2024年5月14日

 (1 則留言) (0 個反應) (0 位負責人)Ruby (252 個分叉)auto 404
documentationgithub_actionshelp wantedkeep

倉庫指標

星標
 (135 顆星)
PR 合併指標
 (PR 指標待抓取)

描述

It's difficult for me to trace the exact change related to a given release. I think we can make some updates to the structure of the changelog to make things more user-friendly.

Some improvements ideas:

  • Add a link to the PR(s) that caused the change
  • Use the PR title as the changelog title
  • Include a description for the change (perhaps we can have PR descriptions or content beneath a specific heading determine the description)
  • Have an overall release changelog for contrib as a whole (which PRs have been released? what gems did they impact?)
    • Maybe this looks like a tag that's easy to filter on PRs? Maybe something like this exists and I'm now aware?

貢獻者指南