open-telemetry/opentelemetry-ruby-contrib

Improve changelogs

Aperta

#987 aperta il 14 mag 2024

Vedi su GitHubGuida contributor
 (1 commento) (0 reazioni) (0 assegnatari)Ruby (252 fork)auto 404
documentationgithub_actionshelp wantedkeep

Metriche repository

Star
 (135 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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?

Guida contributor

Direzione di ricerca
Esamina i file di changelog esistenti e identifica i pattern. Quindi proponi una nuova struttura che includa link PR, titoli e descrizioni.
Tech stack
ruby
Dominio
backend
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Git
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
70