Skip to content

Improve changelogs #987

Open
Open
@kaylareopelle

Description

@kaylareopelle

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?

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationgithub_actionsPull requests that update GitHub Actions codehelp wantedExtra attention is neededkeepEnsures stale-bot keeps this issue/PR open

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions