open-telemetry/opentelemetry-ruby-contrib

Improve changelogs

Open

#987 opened on May 14, 2024

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Ruby (252 forks)auto 404
documentationgithub_actionshelp wantedkeep

Repository metrics

Stars
 (135 stars)
PR merge metrics
 (PR metrics pending)

Description

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?

Contributor guide

Research direction
Review the existing changelog files and identify patterns. Then propose a new structure incorporating PR links, titles, and descriptions.
Tech stack
ruby
Domain
backend
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70