badges / badges/shields

Badge request: Kiln review

Open
#1,033 0 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

I would like to add support for badge that summarises the status of a [kiln review](http://help.fogcreek.com/8268/code-reviews-in-kiln).

Example badges:
![Approved example](https://img.shields.io/badge/review-approved-brightgreen.svg)
![Active example](https://img.shields.io/badge/review-active-yellowgreen.svg)
![Needs Work example](https://img.shields.io/badge/review-needs%20work-yellow.svg)
![Abandoned example](https://img.shields.io/badge/review-abandoned-lightgrey.svg)
![Rejected example](https://img.shields.io/badge/review-rejected-red.svg)

Example url:
`https://img.shields.io/fogcreek/kiln/review/K12345.svg`

This would be using the [kiln review api 2.0](https://developers.fogbugz.com/default.asp?W209)

What I'm most unsure about is that because this is a service behind a paywall, I don't think I would be able to add service tests or live examples to the try.html. So I'm also a little unsure if shields accepts support for services like this.

I'm interested in submitting a pull request for this but just want to make this feature request is all good first.

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the Kiln Review API 2.0 documentation and the existing badge service patterns. Check try.html and determine how service tests or live examples can work for a paywalled service. Done means a Kiln review URL reports the requested statuses with the documented badge colors and has an agreed test strategy.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
api, backend
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 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.