karma-runner/karma

The documentation needs work for begginers

Open

#1 315 ouverte le 17 févr. 2015

Voir sur GitHub
 (9 commentaires) (0 réactions) (0 assignés)JavaScript (1 703 forks)batch import
help wantedtype: backlogtype: docs

Métriques du dépôt

Stars
 (11 918 stars)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

Description

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.

Guide contributeur

Direction de recherche
Tout d'abord, examinez la documentation actuelle de Karma sur le site web du projet (probablement dans le dossier /docs) pour identifier les sections qui ne sont pas claires. Concentrez vous sur les sections 'Utilisation' et 'Configuration'. Ensuite, consultez la documentation de lanceurs de tests similaires (par exemple, Mocha, Jest) pour vous inspirer sur la manière d'expliquer l'exécution des tests et l'interprétation des résultats. Envisagez d'ajouter des captures d'écran et des guides étape par étape. Enfin, ouvrez une PR qui met à jour les fichiers de documentation concernés.
Stack technique
javascript
Domaine
testing
Type d'issue
Documentation
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
Une demi journée
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
Git
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
80