jquery/sizzle

Reorganize docs

Open

#366 aperta il 11 nov 2015

Vedi su GitHub
 (5 commenti) (0 reazioni) (0 assegnatari)JavaScript (991 fork)batch import
help wanted

Metriche repository

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

Descrizione

README.md should focus first (and most strongly) on using Sizzle, since it gets rendered into https://www.npmjs.com/package/sizzle . This includes API documentation currently in the wiki.

Remaining contents would be better placed in CONTRIBUTING.md and linked to from README.md.

Guida contributor

Direzione di ricerca
Sposta la documentazione dell'API dal wiki in README.md, concentrandoti sull'utilizzo. Quindi sposta le restanti linee guida per lo sviluppo e il contributo in CONTRIBUTING.md e assicurati che README.md colleghi a 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