Add 'how to define spans' meta-guidance by lmolkova · Pull Request #3240 · open-telemetry/semantic-conventions (original) (raw)
Is there a reason not to include a changelog entry?
#2232 was listed as a doc enhancement.
Co-authored-by: Armin Ruech 7052238+arminru@users.noreply.github.com
Is there a reason not to include a changelog entry?
#2232 was listed as a doc enhancement.
good question. In my view changelog is a summary of things that have changed that's relevant to consumers. This doc does not change any conventions and users don't need to be notified. In this sense, it's similar to CI fixes and internal docs updates. As you noticed we're not consistent and some PRs include changelog even when they don't change anything for consumers.
Is there a reason not to include a changelog entry?
#2232 was listed as a doc enhancement.good question. In my view changelog is a summary of things that have changed that's relevant to consumers. This doc does not change any conventions and users don't need to be notified. In this sense, it's similar to CI fixes and internal docs updates. As you noticed we're not consistent and some PRs include changelog even when they don't change anything for consumers.
I feel that we could count writers of decentralized semantic conventions as consumers.
Any enhancement to the how-to-write-conventions would be of interest to them.
Co-authored-by: Joao Grassi 5938087+joaopgrassi@users.noreply.github.com
Merged via the queue into open-telemetry:main with commit 9e37bc2
16 checks passed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
[ Show hidden characters]({{ revealButtonHref }})