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

Badges and Licensing on the Repo Readme #149

Closed
dabangarang opened this issue Jul 1, 2020 · 3 comments
Closed

Badges and Licensing on the Repo Readme #149

dabangarang opened this issue Jul 1, 2020 · 3 comments
Assignees
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@dabangarang
Copy link

Is your feature request related to a problem?
In an effort to have the OpenTelemetry C++ SDK be as up-to-date and consistent with the other more established SDKs, (Python, Java) there should be some sort of status tracking on the main Readme.md file, so that any observer of the repo will be able to quickly and efficiently know of the progress, reliability, and licensing of the codebase.

Describe the solution you'd like
We could simply make use of the open source repo-badges (https://github.com/dwyl/repo-badges), version badges (https://github.com/badges/shields) and license badges (https://gist.github.com/lukas-h/2a5d00690736b4c3a7ba) and add them to the current readme, so that the documentation would look similar to its sister repositories: (screenshot of the Python Readme badges for reference)

Screen Shot 2020-07-01 at 12 21 59 PM

@pyohannes pyohannes added documentation Improvements or additions to documentation good first issue Good for newcomers labels Jul 1, 2020
@huyan0
Copy link
Member

huyan0 commented Jul 1, 2020

Hi! I’m interested in working on this issue. Can you please assign to me and my mentor @alolita.

@pyohannes
Copy link
Contributor

Assigned.

@pyohannes
Copy link
Contributor

Thanks for fixing this @huyan!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

4 participants