envoyproxy/envoy

Fix proper noun capitalization in documentation

Aperta

#20.238 aperta il 7 mar 2022

Vedi su GitHubGuida contributor
 (19 commenti) (0 reazioni) (1 assegnatario)C++ (5373 fork)batch import
area/docsbeginnerenhancementhelp wantedno stalebot

Metriche repository

Star
 (27.997 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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

Guida contributor

Direzione di ricerca
Rivedi i commenti dell'issue (16 commenti) per le indicazioni dei maintainer su quali termini correggere (ad es. 'Envoy', 'HTTP', 'CEL'). Cerca nella directory di documentazione del repository le occorrenze delle versioni in minuscolo e correggile. Assicurati la coerenza con la guida di stile del progetto. Non sono richieste modifiche al codice.
Tech stack
Nessuno
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
1
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Meno di 1 ora
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Git
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
90