badges / badges/shields

Badge Request: GitHub projects

Open
#4,844 6 comments 0 reactions 0 assignees View on GitHub
service-badge
Dominant language
JavaScript
Stars
27.2k
Forks
5.6k
Avg merge
1d 8h
Merged PRs (30d)
46

Description

:clipboard: **Description**

I sow there's the GitHub's milestone completion badge #1209 , and it's a pretty cool one.
But i was wondering about a GitHub's project badge.

something like
- `projectname | 42%` cards completed for the whole project (might be of a green color)
- `projectname | 3 in progress` cards in progress, might have a purple background similiar to github's projects colors.
- `projectname | 8 columnName` or `projectname | columnName 7/10` cards completed in a single column
- `bug triage | 5 in review` the number of cards could go before the name, it reads better imo.

or generally inspired by the milestone's ones, since projects and milestones are similiar.

**Examples with static badges**

![project completion](https://img.shields.io/badge/v2.0-42%25-yellow)
![total in progress](https://img.shields.io/badge/bug_triage-12_to_do-inactive) ![total in progress](https://img.shields.io/badge/bug_triage-3_in_progress-blueviolet) ![total in progress](https://img.shields.io/badge/bug_triage-5_completed-success)
![column](https://img.shields.io/badge/cool_project-6_my_column-informational)

:link: **Data**

There are GitHub's APIs. I think for public repos it doesn't require an API key.
https://developer.github.com/v3/projects/

:microphone: **Motivation**

It would be nice for those who manage progress using github's projects.

Contributor guide

Open the contributing guide

Research direction

Start with the GitHub Projects API documentation linked in the issue and compare its scope with the existing milestone completion badge (#1209). Before implementation, narrow the proposal to a specific project metric and badge format; done should mean that one defined metric can be retrieved and rendered reliably for supported public projects.

Written by the indexing model from the issue text.

Assessment

Tech stack
github, javascript
Domain
api, devtools
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.