dotnet/msbuild

More informative Check annotation on public API change

Open

#4,817 opened on Oct 15, 2019

View on GitHub
 (0 comments) (0 reactions) (0 assignees)C# (1,364 forks)batch import
Area: Our Own Buildhelp wantedtriaged

Repository metrics

Stars
 (5,062 stars)
PR merge metrics
 (Avg merge 11d 7h) (125 merged PRs in 30d)

Description

Look at https://github.com/microsoft/msbuild/pull/4814/checks?check_run_id=260937103:

image

This is almost helpful, but it could be dramatically more helpful if it used the Checks API to actually annotate the diff in the file.

Contributor guide

Research direction
Understand the GitHub Checks API and its annotation capabilities, then trace how MSBuild currently posts check runs and modify the code to include diff annotations.
Tech stack
csharp
Domain
build systemapi
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitC#GitHub Checks API
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70