Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve visibility of used spec version in the semconv repo #558

Merged

Conversation

joaopgrassi
Copy link
Member

In #473 there was some confusion and back and forth regarding links to the specification repo. The confusion was about if links to the spec repo should point to main or to a specific tag.

Today, we don't have any mention in CONTRIBUTING.md that links to the spec should point to a tag. Also, it is not clear which version of the spec this repo is targeting. We only have this text in the root readme:

This repository is currently using this specification version

Which can be easily missed since it's not obvious at first sight.

To improve things, I propose in this PR:

  • To add a badge where we can show which spec version we are currently targeting
  • Add the requirement to CONTRIBUTING.md that links to the spec should point to the current used spec version
  • Update the badge version when the update_specification_version.sh is executed

@joaopgrassi joaopgrassi requested review from a team November 23, 2023 14:33
@joaopgrassi joaopgrassi mentioned this pull request Nov 23, 2023
3 tasks
Copy link
Member

@arminru arminru left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM - thank you!

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Show resolved Hide resolved
@arminru arminru added the editorial Editorial changes only (typos, changelog, ...). No content-related changes of any kind. label Nov 23, 2023
Copy link
Contributor

@pyohannes pyohannes left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, that looks great.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
@joaopgrassi joaopgrassi merged commit 0c6d5e1 into open-telemetry:main Nov 24, 2023
9 checks passed
@joaopgrassi joaopgrassi deleted the improve-spec-version-used branch November 24, 2023 13:08
pyohannes pushed a commit to pyohannes/semantic-conventions that referenced this pull request Jan 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
editorial Editorial changes only (typos, changelog, ...). No content-related changes of any kind.
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

4 participants