Code-dot-mil/code.mil

Add documentation on how to do good OSS documentation

Aperta

#240 aperta il 6 set 2018

Vedi su GitHubGuida contributor
 (17 commenti) (0 reazioni) (0 assegnatari)JavaScript (115 fork)batch import
[effort] small[issue-type] content[skill-level] beginnercode.govhelp wanted

Metriche repository

Star
 (1238 stelle)
Metriche merge PR
 (Nessuna PR mergiata in 30 g)

Descrizione

Feature

We would like to have better documentation on how to create good open source software documentation as guidance for Department organizations wishing to open source things. This should include things like relevant sections of a "contributing" doc (not just a link to an example), how to write and review PRs, good commit messages, how to write a good GH issue, etc.

Page(s) Affected

This could go on https://www.code.mil/how-to-open-source.html ("How to Open Source"), but it could live on it's own page, linked a couple of places.

Guida contributor

Direzione di ricerca
Esamina la documentazione esistente su code.mil, in particolare la pagina 'How to Open Source'. Ricerca le migliori pratiche per i documenti di contribuzione OSS, le linee guida per la revisione delle PR, i messaggi di commit e la scrittura delle issue. Proponi una struttura per la nuova pagina di documentazione.
Tech stack
javascript
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.
Mezza giornata
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.
70