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?

贡献者指南