envoyproxy/envoy

Fix proper noun capitalization in documentation

Open

#20 238 ouverte le 7 mars 2022

Voir sur GitHub
 (17 commentaires) (0 réactions) (1 assigné)C++ (5 373 forks)batch import
area/docsbeginnerenhancementhelp wantedno stalebot

Métriques du dépôt

Stars
 (27 997 stars)
Métriques de merge PR
 (Merge moyen 8j) (378 PRs mergées en 30 j)

Description

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

Guide contributeur

Direction de recherche
Examinez les commentaires de l'issue (16 commentaires) pour obtenir les directives des mainteneurs sur les termes à corriger (par exemple, 'Envoy', 'HTTP', 'CEL'). Recherchez dans le répertoire de documentation du dépôt les occurrences des versions en minuscules et corrigez les. Assurez vous de la cohérence avec le guide de style du projet. Aucune modification de code n'est requise.
Stack technique
Aucun
Domaine
documentation
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
1
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Moins d'une heure
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Git
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
90