semantic-release/semantic-release

Documentation improvement - Help wanted!

Open

#653 aperta il 10 feb 2018

Vedi su GitHub
 (15 commenti) (1 reazione) (0 assegnatari)JavaScript (1638 fork)batch import
good first issuehelp wanted

Metriche repository

Star
 (19.681 star)
Metriche merge PR
 (Merge medio 3h 15m) (33 PR mergiate in 30 g)

Descrizione

Most of the documentation has been rewritten recently. The content minimum content we need is there but there is a lot that can be done to improve it.

If you'd like to contribute to the semantic-release project, helping with the following would be much appreciated:

  • Fix typo, misspelling and gramatical mistakes
  • Improve language: make short and simpler sentences, improve clarity
  • Harmonize the style and format, especially regarding code quote, markdown table, capitalization of brands, links

See CONTRIBUTING.md#documentation for all the details.

All the repository in the semantic-release organization need some improvement regarding the documentation!

Thanks!

Guida contributor

Direzione di ricerca
Identifica i file di documentazione che necessitano di miglioramenti, correggi i refusi e migliora la chiarezza utilizzando le linee guida per il markdown e lo stile da CONTRIBUTING.md.
Tech stack
javascript
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
Git
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
90