akka/akka-core

Consistent doc header casing

Aperta

#27.741 aperta il 18 set 2019

Vedi su GitHubGuida contributor
 (5 commenti) (0 reazioni) (0 assegnatari)Scala (3547 fork)batch import
1 - triagedhelp wantednice-to-have (low-prio)t:docs

Metriche repository

Star
 (13.277 stelle)
Metriche merge PR
 (Merge medio 8g 19h) (10 PR mergiate in 30 g)

Descrizione

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)

Guida contributor

Direzione di ricerca
Identifica tutte le intestazioni della documentazione e applica la strategia di capitalizzazione scelta: Title Case per i titoli di pagina (h1) e normal sentence case per i sottotitoli.
Tech stack
scala
Dominio
documentation
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
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.
85