envoyproxy/envoy

format: add checks for type aliases

Open

#9,840 opened on Jan 27, 2020

View on GitHubContributor guide
 (2 comments) (0 reactions) (0 assignees)C++ (5,373 forks)batch import
area/buildbeginnerenhancementhelp wanted

Repository metrics

Stars
 (27,997 stars)
PR merge metrics
 (PR metrics pending)

Description

Description: Envoy has several conventions around type aliases defined in STYLE.md. Right now these conventions are checked by reviewers. It would be really useful to have the conventions checked in the format CI run.

This could be done with regexes in the check_format.py script, or optimally by extending clang-tidy.

Contributor guide

Research direction
Examine existing format checks in check format.py and STYLE.md for type alias conventions. Consider implementing a regex in check format.py or a clang tidy check.
Tech stack
cpp
Domain
backend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
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.
Mostly clear
Prerequisites
GitC++
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70