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.

Sign up for GitHub

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

Jump to bottom

ReadMe.md -- Add current build/workflow status and license badge #3

Open
TylerTrott opened this issue Oct 9, 2021 · 1 comment
Open

ReadMe.md -- Add current build/workflow status and license badge #3

TylerTrott opened this issue Oct 9, 2021 · 1 comment
Labels
good first issue Good for newcomers Hacktoberfest

Comments

@TylerTrott
Copy link

A status badge shows whether a workflow is currently failing or passing. In addition to this, it is important to show our Github BSD 3-clause License badge on all public repositories.

A common place to add the status and license badge is in the README.md at the top alongside the GitHub License.

+ ![example workflow](https://github.com/<OWNER>/<REPOSITORY>/actions/workflows/<WORKFLOW_FILE>/badge.svg)
+ [![GitHub License](https://img.shields.io/badge/license-BSD3-blue.svg)](./LICENSE)
@deepakdinesh1123
Copy link

Where is the WORKFLOW_FILE located?

@furiousluck furiousluck mentioned this issue Oct 14, 2021
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
good first issue Good for newcomers Hacktoberfest
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@deepakdinesh1123 @TylerTrott