ianmackenzie/elm-geometry

Convert documentation examples to tests

Ouverte

#27 ouverte le 12 oct. 2017

Voir sur GitHubGuide contributeur
 (5 commentaires) (0 réaction) (0 personne assignée)Elm (28 forks)auto 404
Hacktoberfestgood first issuehelp wantedtests

Métriques du dépôt

Stars
 (186 étoiles)
Métriques de merge PR
 (Aucune PR mergée en 30 j)

Description

I started converting a bunch of the examples shown in the documentation to tests; for example see commits 8025fe78ba15395cd07a0a410c0240c8e2e11282 and be3dbb11f58d2d79fe702aa40bc033163f25537c. It would be great if someone could help converting over more of them! As nice as it would be, I don't think it's feasible to use something like stoeffel/elm-verify-examples since most tests in this package require using custom comparison functions that include a small numerical tolerance for roundoff.

The general procedure would be to find examples in a particular module, convert them to tests in the corresponding tests file, then run the tests locally using elm-test to verify that they pass.

Guide contributeur

Direction de recherche
Localisez les exemples de documentation dans les fichiers source du module, convertissez les en cas de test dans le fichier de test correspondant et assurez vous qu'ils réussissent en utilisant elm test.
Stack technique
Aucun
Domaine
documentationtesting
Type d'issue
Test
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.
1-3 heures
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
GitElmelm test
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
80