badges/shields

Badge request: GitHub Discussions

Open

#6047 opened on Jan 12, 2021

View on GitHub
 (13 comments) (11 reactions) (0 assignees)JavaScript (22,337 stars) (5,423 forks)batch import
good first issueservice-badge

Description

:clipboard: Description

Since GitHub has recently launched Discussions, the relevant badges will be useful. The number of answered/unanswered/total discussions is the most obvious stats to be displayed, e.g.: https://img.shields.io/badge/discussions-100%20open-brightgreen

:link: Data

It seems that while the GH Discussions feature is still in beta, no relevant public API is available at the moment. If that's true (I can't find any other information but other thoughts on this issue are most welcome), we'll have to wait when the API is implemented.

:microphone: Motivation

It can bring more people to discussions what is especially relevant now as the feature has been recently introduced and not everyone visiting the repo may be aware of it.

Personally, we'd like to use it for werf and some other projects to let our community know they can use GH discussions to interact with developers and other users. Previously, we've been using our self-hosted forums (based on Discourse) and relevant badges.

Contributor guide

Tech stack
javascriptnodejs
Domain
apibackend
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
4
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
blocked
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
20
Research direction
The issue is blocked on GitHub Discussions API availability. Monitor https://github.com/github/feedback/discussions/43 for updates. Once the API is released, implement a new badge service following the pattern of existing GitHub issue badges in src/services/github/. Ensure the badge displays discussion count and optionally open/closed status. Consider adding tests and documentation.