Badge Documentation

Add GitScope badges to your README to showcase your project's health metrics. Free for all public repositories.

1Quick Start

Add this to your README.md (replace owner/repo with your repository):

[![Repo Health](https://api.gitscope.dev/api/badges/owner/repo.svg)](https://gitscope.dev)

Preview:

Repo Health Badge Example

2Available Badges

Repo Health

Overall repository health score from 0-100%. Calculated from activity, maintenance, community engagement, and issue management.

Repo Health

Markdown

[![Repo Health](https://api.gitscope.dev/api/badges/owner/repo/health.svg)](https://gitscope.dev)

Maintained

Shows maintenance status: "very active", "active", "maintained", or "stale" based on recent commit and issue activity.

Maintained

Markdown

[![Maintained](https://api.gitscope.dev/api/badges/owner/repo/maintained.svg)](https://gitscope.dev)

Response Time

Activity-based indicator showing how recently the repo was updated. Based on last push date.

Response Time

Markdown

[![Response Time](https://api.gitscope.dev/api/badges/owner/repo/response-time.svg)](https://gitscope.dev)

Contributors

Actual contributor count from GitHub API. Counts contributors to the default branch.

Contributors

Markdown

[![Contributors](https://api.gitscope.dev/api/badges/owner/repo/contributors.svg)](https://gitscope.dev)

Contributor Friendly

Indicates whether the repo welcomes new contributors based on good first issues, contributing guides, and response patterns.

Contributor Friendly

Markdown

[![Contributor Friendly](https://api.gitscope.dev/api/badges/owner/repo/contributor-friendly.svg)](https://gitscope.dev)

Issues Welcome

Shows if the project actively accepts and responds to issue reports.

Issues Welcome

Markdown

[![Issues Welcome](https://api.gitscope.dev/api/badges/owner/repo/issues.svg)](https://gitscope.dev)

Documentation

Documentation quality indicator based on README completeness, wiki presence, and linked documentation.

Documentation

Markdown

[![Documentation](https://api.gitscope.dev/api/badges/owner/repo/docs.svg)](https://gitscope.dev)

Issues Resolved

Actual percentage of issues that have been closed. Calculated as closed/(open+closed).

Issues Resolved

Markdown

[![Issues Resolved](https://api.gitscope.dev/api/badges/owner/repo/resolved.svg)](https://gitscope.dev)

Label Count

Count of open issues with a specific label. Replace "bug" with any label name (case-sensitive).

Label Count

Markdown

[![Label Count](https://api.gitscope.dev/api/badges/owner/repo/label/bug.svg)](https://gitscope.dev)

3Badge Styles

Customize badge appearance with the ?style= parameter:

Example with style parameter

[![Repo Health](https://api.gitscope.dev/api/badges/owner/repo.svg?style=flat)](https://gitscope.dev)

4Custom Colors

Customize badge colors with URL parameters:

Value Color

Use ?color= to change the value background:

bluecyanpurplepink
https://api.gitscope.dev/api/badges/owner/repo.svg?color=blue

Label Color (Dark Mode)

Use ?labelColor= for dark backgrounds:

dark333black
https://api.gitscope.dev/api/badges/owner/repo.svg?labelColor=dark

Available Colors

brightgreengreenyelloworangeredbluecyanpurplepinktealindigogray

Or use hex codes: ?color=ff69b4 or ?color=#06b6d4

5Embedding Formats

Markdown

[![Repo Health](https://api.gitscope.dev/api/badges/owner/repo.svg)](https://gitscope.dev)

HTML

<a href="https://gitscope.dev"><img src="https://api.gitscope.dev/api/badges/owner/repo.svg" alt="Repo Health" /></a>

reStructuredText

.. image:: https://api.gitscope.dev/api/badges/owner/repo.svg
   :target: https://gitscope.dev
   :alt: Repo Health

6How Scores Are Calculated

Health Score (0-100%)

The health score combines multiple factors from public GitHub data:

Activity

Days since last commit (up to +20 points)

Issue Management

Open issues relative to popularity (up to +15)

Community

Description, license, homepage (up to +10)

Engagement

Stars and forks count (up to +5)

Maintained

Based on days since last push. "Very active" = pushed in last week.

Documentation

Checks for description, homepage, license, and wiki presence.

Contributors

Actual count from GitHub API. Counts default branch contributors only.

Issues Resolved

Actual percentage: closed / (open + closed). Uses GitHub Search API.

Label Count

Count of open issues with a specific label. Great for bug counts.

Response Time

Based on last push date. Register for actual issue response times.

7FAQ

Will badges slow down my README?

No. Badges are served from Cloudflare's global edge network with a 15-minute cache. Response times are typically under 100ms worldwide.

How often do badges update?

Badge data is cached for 15 minutes. Health metrics are recalculated hourly from your repository's activity.

Do I need to sign up?

No signup required for badges. They work with any public GitHub repository instantly. Sign up only if you want detailed analytics and AI-powered triage.

How accurate are the metrics?

Most badges use accurate GitHub API data. Contributors shows actual count (default branch only). Issues Resolved shows actual closed/total percentage. Response Time is based on last push date, not actual issue response times - register for those metrics.

Want more than badges?

Get AI-powered issue triage, automated responses, duplicate detection, and detailed analytics for your repositories.