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

[DOCUMENTATION] Streamline badges in READMEs #364

Closed
silkentrance opened this issue Dec 2, 2022 · 0 comments · Fixed by #365
Closed

[DOCUMENTATION] Streamline badges in READMEs #364

silkentrance opened this issue Dec 2, 2022 · 0 comments · Fixed by #365

Comments

@silkentrance
Copy link
Member

silkentrance commented Dec 2, 2022

All badges must be placed before the first heading.

Example Root Package Badges

License Build Status Issues Pull Requests

Example Package Badges

Get it on NPM License Build Status Coverage Issues
Pull Requests

General Badges

License Badge

[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

Issues Badge

[![Issues](https://img.shields.io/github/issues/testdeck/testdeck.svg)](https://github.com/testdeck/testdeck/issues)

PR Badge

[![Pull Requests](https://img.shields.io/github/issues-pr/testdeck/testdeck.svg)](https://github.com/testdeck/testdeck/pulls)

Github CI Badge

[![Build Status](https://github.com/testdeck/testdeck/actions/workflows/ci.yml/badge.svg)](https://github.com/testdeck/testdeck/actions/workflows/ci.yml)

Package Specific Badges

NPM Badge

E.g.

[![Get it on NPM](https://img.shields.io/npm/v/@testdeck/di-typedi.svg)](https://www.npmjs.com/package/@testdeck/di-typedi)

Issues Badge

[![Issues](https://img.shields.io/github/issues/testdeck/testdeck/@testdeck/di-typedi)](https://github.com/testdeck/testdeck/issues)

PR Badge

[![Issues](https://img.shields.io/github/issues-pr/testdeck/testdeck/@testdeck/di-typedi)](https://github.com/testdeck/testdeck/pulls)

SonarCloud Coverage Badge

E.g.

[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=testdeck_di_typedi&metric=coverage)](https://sonarcloud.io/summary/new_code?id=testdeck_di_typedi)
@silkentrance silkentrance added the internal Some internal task/chore label Dec 2, 2022
@silkentrance silkentrance self-assigned this Dec 2, 2022
@silkentrance silkentrance added documentation and removed internal Some internal task/chore labels Dec 2, 2022
@silkentrance silkentrance changed the title [INTERNAL] Streamline badges in READMEs [DOCUMENTATION] Streamline badges in READMEs Dec 2, 2022
silkentrance added a commit that referenced this issue Dec 3, 2022
@silkentrance silkentrance linked a pull request Dec 3, 2022 that will close this issue
silkentrance added a commit that referenced this issue Dec 3, 2022
@silkentrance silkentrance added this to the v0.3.3 milestone Dec 5, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment