karma-runner/karma

The documentation needs work for begginers

Open

#1315 aperta il 17 feb 2015

Vedi su GitHub
 (9 commenti) (0 reazioni) (0 assegnatari)JavaScript (1703 fork)batch import
help wantedtype: backlogtype: docs

Metriche repository

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

Descrizione

After reading through the intro material and other pages on the webiste, I have no idea how to develop with karma. The most I can figure out from karma's website is how to start the karma server. After that, what do I do? How do i run tests in a way where I can step through code in the browser running the test?

Also, there is 0 documentation on how to interpret karma's output. It isn't self explanatory. Is everything that's outputting a failed test? How bout some screen shots that explain some of these things.

Guida contributor

Direzione di ricerca
Innanzitutto, rivedi la documentazione attuale di Karma sul sito web del progetto (probabilmente nella cartella /docs) per identificare le sezioni poco chiare. Concentrati sulle sezioni 'Utilizzo' e 'Configurazione'. Quindi, esamina la documentazione di runner di test simili (ad es. Mocha, Jest) per trarre ispirazione su come spiegare l'esecuzione dei test e l'interpretazione dell'output. Considera l'aggiunta di screenshot e guide passo passo. Infine, apri una PR che aggiorni i file di documentazione pertinenti.
Tech stack
javascript
Dominio
testing
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.
80