siddharthkp/bundlesize

Integrate the new checks API

Open

#223 opened on Jun 5, 2018

View on GitHub
 (1 comment) (3 reactions) (0 assignees)JavaScript (4,434 stars) (218 forks)batch import
enhancementhelp wanted

Description

This will let us show detailed comments instead of just a line!

https://developer.github.com/changes/2018-05-07-new-checks-api-public-beta/

Contributor guide

Tech stack
javascriptnodejs
Domain
backenddeveloper experience
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
GitHub API knowledgeNode.js experiencefamiliarity with bundlesize codebase
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30
Research direction
Research the GitHub Checks API documentation (https://developer.github.com/changes/2018-05-07 new checks api public beta/) and understand the endpoints and data format. Examine the existing bundlesize codebase, particularly how comments are currently posted, to determine where to integrate the new API. Consider creating a new module or modifying existing files to add checks based commenting.