Skip to content

Project status badges

Jump to bottom Edit New page
Greg Swindle edited this page Apr 25, 2018 · 4 revisions

GitHub Project Badges!

GitHub provides APIs, some of which expose the health and vibrancy of repositories. You can display these metrics with badges.

Table of contents

README badges

The MIT License FOSSA Status
NSP Status Dependency Status Development Dependency Status
MacOS and Ubuntu build statuses Windows build status Coverage percentage Codacy code quality
NPMS score NPM downloads per month

  • megaphone Declare the quality of your code, community, and legal awareness up front with these badges.

    README badges say a lot with very little space.

    • OSS license: Indicate your product's OSS license to potential consumers.
    • Legal obligations: Scan the OSS licenses of your depenedencies, too.
    • Security vulnerabilities: Display security scan results.
    • Dependency drift: Demonstrate your commitment to updates.
    • Build status: Invite people to install on your OSS's target platforms.
    • Test coverage: Your OSS behaves as intended.
    • Code quality: Consistency and safety invite contributions.
    • Popularity: Hint at (hopefully growing!) popularity.

  • link Be sure each badge links to a CI service or report for people who want to take a deeper look.

🔝 Back to TOC

Community and licenses

Author

🔝 Back to TOC

Contributor count

🔝 Back to TOC

License

🔝 Back to TOC

Maintenance

🔝 Back to TOC

Search hit counter

🔝 Back to TOC

Used by projects count

🔝 Back to TOC

Issues

🔝 Back to TOC

Issue age

🔝 Back to TOC

Issue author

🔝 Back to TOC

Closed issues

🔝 Back to TOC

Issue comments

🔝 Back to TOC

Issue label

🔝 Back to TOC

Issue last update

🔝 Back to TOC

Issue state

🔝 Back to TOC

Issue title

🔝 Back to TOC

"Raw" issues

🔝 Back to TOC

Grand total closed ("raw" closed issues)

🔝 Back to TOC

Issues by label

🔝 Back to TOC

"Raw" issues by label

🔝 Back to TOC

Pull requests

🔝 Back to TOC

Closed pull request count

🔝 Back to TOC

Pull requests by label

🔝 Back to TOC

Pull requests by label

🔝 Back to TOC

Grand total ("raw" pull requests)

🔝 Back to TOC

"Raw" closed pull requests

🔝 Back to TOC

Pull request check state

🔝 Back to TOC

Pull request check contexts

🔝 Back to TOC

Releases

Release Date

🔝 Back to TOC

GitHub (Pre-)Release Date

🔝 Back to TOC

Repositories

Code size (bytes)

🔝 Back to TOC

Commit activity the past week, 4 weeks, year

🔝 Back to TOC

Last commit

🔝 Back to TOC

Last commit (to a topic branch)

🔝 Back to TOC

Language count

🔝 Back to TOC

Top language

🔝 Back to TOC

Repository size (bytes)

🔝 Back to TOC

File size

🔝 Back to TOC

Creative Commons License
This work is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License.

Home Wiki Home

Git Git logo

Terminal CLI snippets for git.

  1. Git tips
  2. Git notes

Pre-release checklist

tasklist This checklist—adapted from bahmutov/npm-module-checklist link-external—provides useful tips to ensure your module is ready for production deployment and publication.

Repo status badges

verified Openly declare the health of your product, project, community, and source code with these essential badges. (GitHub SaaS only.)

UX Cheat-sheets

Info Icons, images, gists, code snippets, etc.

  1. Architecture Decision Record status labels
  2. Octicon cheatsheet
  3. Project status badges
  4. TechRadar labels

Resources

Telescope Stellar languages, frameworks, platform, techniques, and tools.

Clone this wiki locally