badges / badges/shields

Badge Request: Support contribute.design – open to Design Contributions badge

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

Description

:clipboard: **Description**

- Which service is this badge for: https://contribute.design
- What sort of information should this badge show?
`.DESIGN:contributes` | `.DESIGN:pending` | `.DESIGN:failed`

:link: **Data**

- Is there a public API? Yes
- Does the API require an API key? No
- Link to the API documentation.

We did already prepare a custom API endpoint which will return the default `/endpoint` JSON formatted data – but are open to any required modifications

```ts
interface ShieldResponse {
schemaVersion: 1
label: string
labelColor: 'black'
message: string
color: 'blue' | 'green' | 'red'
isError: boolean
logoSvg: string
}
```

The API endpoint to request the json:
https://contribute.design/api/shieldsio/:user/:repo

The URL the Badge should link to:
https://contribute.design/:user/:repo

Here's a sample response for `badges/shields`
https://contribute.design/api/shieldsio/badges/shields

```json
{
"schemaVersion": 1,
"label": ".DESIGN",
"labelColor": "black",
"message": "pending",
"color": "blue",
"isError": false,
"logoSvg": "\n"
}
```

We do fill the `message` & `color` fields according to the repository status in our database.

:microphone: **Motivation**

👋 I'm the creator of https://contribute.design

We're trying to enable more Designers to contribute to Open Source projects by listing them and helping them improve their design contribution guidelines.

Open Source projects will require a badge on their README.md to get listed.

Now we obviously created that badge already on our own – but you know – people really love the consistency shields offer so it would be amazing if you could support us :)

Contributor guide

Open the contributing guide

Research direction

Start by reviewing existing service-backed badge implementations in the Shields repository, then inspect the provided contribute.design endpoint and sample response. Done means the requested badge can represent the stated repository statuses, uses the supplied endpoint and link format, and matches the expected Shields response shape.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
api, backend
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.