envoyproxy/envoy

beginner: add coverage

Open

#1,963 opened on Oct 28, 2017

View on GitHub
 (10 comments) (0 reactions) (0 assignees)C++ (5,373 forks)batch import
beginnerhelp wantedtech debt

Repository metrics

Stars
 (27,997 stars)
PR merge metrics
 (Avg merge 8d) (378 merged PRs in 30d)

Description

Going to leave open a persistent beginner ticket for adding coverage: https://s3.amazonaws.com/lyft-envoy/coverage/report-master/coverage.html

There are always a few missing things here and there especially regarding random error handling. If you are a beginner this is a great way to learn and do something valuable.

Rough steps:

  • Look at the coverage report and find something (often a single line) that looks like it should be covered.
  • Find the relevant unit test that should cover it (often in the test tree with the same file name)
  • Write the test
  • Confirm in PR coverage build that line is covered. (Coverage report is posted as a build artifact).

Contributor guide

Research direction
Find an uncovered line in the coverage report and write a unit test for it in the corresponding test file. Ensure the coverage build passes.
Tech stack
cpp
Domain
backendnetworking
Issue type
Test
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
C++Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80