envoyproxy/envoy

Fix proper noun capitalization in documentation

Open

#20.238 aberto em 7 de mar. de 2022

Ver no GitHub
 (17 comments) (0 reactions) (1 assignee)C++ (5.373 forks)batch import
area/docsbeginnerenhancementhelp wantedno stalebot

Métricas do repositório

Stars
 (27.997 stars)
Métricas de merge de PR
 (Mesclagem média 8d) (378 fundiu PRs em 30d)

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

Guia do colaborador

Direção de pesquisa
Revise os comentários da issue (16 comentários) para obter orientação dos mantenedores sobre quais termos corrigir (por exemplo, 'Envoy', 'HTTP', 'CEL'). Procure no diretório de documentação do repositório por ocorrências das versões em minúsculas e corrija as. Garanta a consistência com o guia de estilo do projeto. Nenhuma alteração de código é necessária.
Pilha de tecnologia
None
Domain
documentation
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
1
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
Menos de 1 hora
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Git
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
90