envoyproxy/envoy

Fix proper noun capitalization in documentation

Open

#20.238 geöffnet am 7. März 2022

Auf GitHub ansehen
 (17 Kommentare) (0 Reaktionen) (1 zugewiesene Person)C++ (5.373 Forks)batch import
area/docsbeginnerenhancementhelp wantedno stalebot

Repository-Metriken

Stars
 (27.997 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 8T) (378 gemergte PRs in 30 T)

Beschreibung

For documentation (including API):

  • Proper nouns should be correctly capitalized, e.g. Envoy instead of envoy.
  • Acronyms are always capitalized, e.g. HTTP instead of http, CEL instead of cel. No camel case in docs.

CC @phlax

Contributor Guide

Research-Richtung
Überprüfe die Issue Kommentare (16 Kommentare) für die Anleitung der Maintainer, welche Begriffe zu korrigieren sind (z. B. 'Envoy', 'HTTP', 'CEL'). Durchsuche das Dokumentationsverzeichnis des Repositorys nach Vorkommen der Kleinbuchstaben Versionen und korrigiere sie. Stelle die Konsistenz mit dem Styleguide des Projekts sicher. Es sind keine Codeänderungen erforderlich.
Tech Stack
Keine
Domain
documentation
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Unter 1 Stunde
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.
90