golang/go

doc: eliminate commit-message skew between Contribution Guide and wiki

Open

#25.313 aperta il 9 mag 2018

Vedi su GitHub
 (9 commenti) (2 reazioni) (0 assegnatari)Go (19.008 fork)batch import
DocumentationNeedsInvestigationhelp wanted

Metriche repository

Star
 (133.883 star)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

After @rasky's updates, https://tip.golang.org/doc/contribute.html#commit_messages has a nice, clear guide to Go commit messages. https://github.com/golang/go/wiki/CommitMessage has a very similar guide.

Unfortunately, they have a bit of skew: for example, the wiki mentions a 76-column limit, whereas contribute.html does not.

We should eliminate that skew: either both documents should list the full details, or one should provide a more concise summary and link to the other for details.

Guida contributor

Direzione di ricerca
Confronta i due documenti ed elimina le incongruenze. O duplicate i dettagli completi o rendete uno un riepilogo con un collegamento all'altro.
Tech stack
go
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
Nessuno
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
90