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

Standardize README with shield badges #1283

Closed
marcduiker opened this issue May 8, 2024 · 8 comments
Closed

Standardize README with shield badges #1283

marcduiker opened this issue May 8, 2024 · 8 comments
Assignees
Labels
good first issue Good for newcomers
Milestone

Comments

@marcduiker
Copy link
Contributor

marcduiker commented May 8, 2024

-- Updated so all badges are links, added FOSSA license scan --

We want to update the README for all Dapr repos so they all include shield badges for YouTube, Discord, X/Twitter and ensure they are all in the same style. See: dapr/community#355

These are the shield badges for the dotnet-sdk repo.

NuGet Version NuGet Downloads GitHub Actions Workflow Status codecov GitHub License FOSSA Status GitHub issue custom search in repo Discord YouTube Channel Views X (formerly Twitter) Follow

Snippet to include in the README:

[![NuGet Version](https://img.shields.io/nuget/v/Dapr.Client?logo=nuget&label=Latest%20version&style=flat)](https://www.nuget.org/packages/Dapr.Client) [![NuGet Downloads](https://img.shields.io/nuget/dt/Dapr.Client?style=flat&logo=nuget&label=Downloads)](https://www.nuget.org/packages/Dapr.Client) [![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/dapr/dotnet-sdk/.github%2Fworkflows%2Fsdk_build.yml?branch=master&label=Build&logo=github)](https://github.com/dapr/dotnet-sdk/actions/workflows/sdk_build.yml) [![codecov](https://codecov.io/gh/dapr/dotnet-sdk/branch/master/graph/badge.svg)](https://codecov.io/gh/dapr/dotnet-sdk) [![GitHub License](https://img.shields.io/github/license/dapr/dotnet-sdk?style=flat&label=License&logo=github)](https://github.com/dapr/dotnet-sdk/blob/master/LICENSE) [![FOSSA Status](https://app.fossa.com/api/projects/custom%2B162%2Fgithub.com%2Fdapr%2Fdotnet-sdk.svg?type=shield&issueType=license)](https://app.fossa.com/projects/custom%2B162%2Fgithub.com%2Fdapr%2Fdotnet-sdk?ref=badge_shield&issueType=license) [![GitHub issue custom search in repo](https://img.shields.io/github/issues-search/dapr/dotnet-sdk?query=type%3Aissue%20is%3Aopen%20label%3A%22good%20first%20issue%22&label=Good%20first%20issues&style=flat&logo=github)](https://github.com/dapr/dotnet-sdk/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) [![Discord](https://img.shields.io/discord/778680217417809931?label=Discord&style=flat&logo=discord)](http://bit.ly/dapr-discord) [![YouTube Channel Views](https://img.shields.io/youtube/channel/views/UCtpSQ9BLB_3EXdWAUQYwnRA?style=flat&label=YouTube%20views&logo=youtube)](https://youtube.com/@daprdev) [![X (formerly Twitter) Follow](https://img.shields.io/twitter/follow/daprdev?logo=x&style=flat)](https://twitter.com/daprdev)

Contributing

Please label this as good first issue.

@m3nax
Copy link
Contributor

m3nax commented May 9, 2024

/assign

@m3nax
Copy link
Contributor

m3nax commented May 13, 2024

@marcduiker done

@marcduiker
Copy link
Contributor Author

Thanks for adding the badges @m3nax!

Could you make another PR and add back the # Dapr SDK for .NET on the first line of the README, please? This has unintentionally been removed with your change :). See the diff: https://github.com/dapr/dotnet-sdk/pull/1284/files

@m3nax
Copy link
Contributor

m3nax commented May 15, 2024

@marcduiker fixed

@marcduiker
Copy link
Contributor Author

Thanks @m3nax !

@mikeee
Copy link
Member

mikeee commented May 16, 2024

@marcduiker - just noticed that some of links aren't working or included as intended. The twitter badge for example only contains the image url and navigates to the badge image when clicked.
The others are: latest version, build and license

@m3nax
Copy link
Contributor

m3nax commented May 16, 2024

Fixed build badge:
build

@marcduiker
Copy link
Contributor Author

@marcduiker - just noticed that some of links aren't working or included as intended. The twitter badge for example only contains the image url and navigates to the badge image when clicked. The others are: latest version, build and license

Thanks @mikeee! I'll update the issue, and re-open. You can use the formatted snippet in this issue @m3nax since I've updated that.

@marcduiker marcduiker reopened this May 16, 2024
@m3nax m3nax mentioned this issue May 17, 2024
3 tasks
@philliphoff philliphoff added this to the v1.14 milestone Jul 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

4 participants