akka/akka-core

Consistent doc header casing

Aberta

#27.741 aberto em 18 de set. de 2019

Ver no GitHubGuia do colaborador
 (5 comentários) (0 reação) (0 responsável)Scala (3.547 forks)batch import
1 - triagedhelp wantednice-to-have (low-prio)t:docs

Métricas do repositório

Stars
 (13.277 estrelas)
Métricas de merge de PR
 (Mesclagem média 8d 19h) (10 fundiu PRs em 30d)

Description

Noted in https://github.com/akka/akka/pull/27708#discussion_r325227829 that our uppercasing in headers is all over the place, we should pick one strategy and stick with it.

My suggestion, Title Capitalization For The Page Title (h1) and Normal capitalization for the subheaders. (I have no writing practice knowledge to motivate it with though)

Guia do colaborador

Direção de pesquisa
Identifique todos os cabeçalhos da documentação e aplique a estratégia de capitalização escolhida: Title Case para títulos de página (h1) e normal sentence case para subtítulos.
Pilha de tecnologia
scala
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.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
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.
85