envoyproxy/envoy

Show `patched` flag in dependency docs

Offen

#25.368 geöffnet am 06.02.2023

Auf GitHub ansehenContributor Guide
 (3 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)C++ (5.373 Forks)batch import
area/docsdependenciesenhancementhelp wanted

Repository-Metriken

Stars
 (27.997 Sterne)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

Many of our (bazel) dependencies have local patches applied

The dependency docs show the commit/version/etc that is compiled into Envoy - but does not indicate whether the dep/source has been patched - probably it would be good to show this

https://www.envoyproxy.io/docs/envoy/latest/intro/arch_overview/security/external_deps.html#external-dependencies

not sure how easy it would be to collate the info as the deps are patched independently of the info in repository_locations but i guess we could shift that info to there

Contributor Guide

Research-Richtung
Untersuchen Sie die Datei repository locations von Envoy, um die aktuelle Abhängigkeitsstruktur zu verstehen. Ermitteln Sie, wie Patches gespeichert und angewendet werden. Schlagen Sie eine Methode vor, um ein patched Flag in repository locations aufzunehmen und aktualisieren Sie den Dokumentationsgenerator, um es anzuzeigen.
Tech Stack
cpp
Domain
documentation
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Git
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
65